com.amazonaws.services.translate.model

Class StartTextTranslationJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.translate.model.StartTextTranslationJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartTextTranslationJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartTextTranslationJobRequest()

Method Summary

Modifier and Type	Method and Description
StartTextTranslationJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() A unique identifier for the request.
String	getDataAccessRoleArn() The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data.
InputDataConfig	getInputDataConfig() Specifies the format and S3 location of the input documents for the translation job.
String	getJobName() The name of the batch translation job to be performed.
OutputDataConfig	getOutputDataConfig() Specifies the S3 folder to which your job output will be saved.
List<String>	getParallelDataNames() The name of a parallel data resource to add to the translation job.
TranslationSettings	getSettings() Settings to configure your translation output, including the option to mask profane words and phrases.
String	getSourceLanguageCode() The language code of the input language.
List<String>	getTargetLanguageCodes() The language code of the output language.
List<String>	getTerminologyNames() The name of a custom terminology resource to add to the translation job.
int	hashCode()
void	setClientToken(String clientToken) A unique identifier for the request.
void	setDataAccessRoleArn(String dataAccessRoleArn) The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data.
void	setInputDataConfig(InputDataConfig inputDataConfig) Specifies the format and S3 location of the input documents for the translation job.
void	setJobName(String jobName) The name of the batch translation job to be performed.
void	setOutputDataConfig(OutputDataConfig outputDataConfig) Specifies the S3 folder to which your job output will be saved.
void	setParallelDataNames(Collection<String> parallelDataNames) The name of a parallel data resource to add to the translation job.
void	setSettings(TranslationSettings settings) Settings to configure your translation output, including the option to mask profane words and phrases.
void	setSourceLanguageCode(String sourceLanguageCode) The language code of the input language.
void	setTargetLanguageCodes(Collection<String> targetLanguageCodes) The language code of the output language.
void	setTerminologyNames(Collection<String> terminologyNames) The name of a custom terminology resource to add to the translation job.
String	toString() Returns a string representation of this object.
StartTextTranslationJobRequest	withClientToken(String clientToken) A unique identifier for the request.
StartTextTranslationJobRequest	withDataAccessRoleArn(String dataAccessRoleArn) The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data.
StartTextTranslationJobRequest	withInputDataConfig(InputDataConfig inputDataConfig) Specifies the format and S3 location of the input documents for the translation job.
StartTextTranslationJobRequest	withJobName(String jobName) The name of the batch translation job to be performed.
StartTextTranslationJobRequest	withOutputDataConfig(OutputDataConfig outputDataConfig) Specifies the S3 folder to which your job output will be saved.
StartTextTranslationJobRequest	withParallelDataNames(Collection<String> parallelDataNames) The name of a parallel data resource to add to the translation job.
StartTextTranslationJobRequest	withParallelDataNames(String... parallelDataNames) The name of a parallel data resource to add to the translation job.
StartTextTranslationJobRequest	withSettings(TranslationSettings settings) Settings to configure your translation output, including the option to mask profane words and phrases.
StartTextTranslationJobRequest	withSourceLanguageCode(String sourceLanguageCode) The language code of the input language.
StartTextTranslationJobRequest	withTargetLanguageCodes(Collection<String> targetLanguageCodes) The language code of the output language.
StartTextTranslationJobRequest	withTargetLanguageCodes(String... targetLanguageCodes) The language code of the output language.
StartTextTranslationJobRequest	withTerminologyNames(Collection<String> terminologyNames) The name of a custom terminology resource to add to the translation job.
StartTextTranslationJobRequest	withTerminologyNames(String... terminologyNames) The name of a custom terminology resource to add to the translation job.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartTextTranslationJobRequest

public StartTextTranslationJobRequest()

Method Detail

setJobName

public void setJobName(String jobName)

The name of the batch translation job to be performed.

Parameters:

jobName - The name of the batch translation job to be performed.

getJobName

public String getJobName()

The name of the batch translation job to be performed.

Returns:

The name of the batch translation job to be performed.

withJobName

public StartTextTranslationJobRequest withJobName(String jobName)

The name of the batch translation job to be performed.

Parameters:

jobName - The name of the batch translation job to be performed.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInputDataConfig

public void setInputDataConfig(InputDataConfig inputDataConfig)

Specifies the format and S3 location of the input documents for the translation job.

Parameters:

inputDataConfig - Specifies the format and S3 location of the input documents for the translation job.

getInputDataConfig

public InputDataConfig getInputDataConfig()

Specifies the format and S3 location of the input documents for the translation job.

Returns:

Specifies the format and S3 location of the input documents for the translation job.

withInputDataConfig

public StartTextTranslationJobRequest withInputDataConfig(InputDataConfig inputDataConfig)

Specifies the format and S3 location of the input documents for the translation job.

Parameters:

inputDataConfig - Specifies the format and S3 location of the input documents for the translation job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOutputDataConfig

public void setOutputDataConfig(OutputDataConfig outputDataConfig)

Specifies the S3 folder to which your job output will be saved.

Parameters:

outputDataConfig - Specifies the S3 folder to which your job output will be saved.

getOutputDataConfig

public OutputDataConfig getOutputDataConfig()

Specifies the S3 folder to which your job output will be saved.

Returns:

Specifies the S3 folder to which your job output will be saved.

withOutputDataConfig

public StartTextTranslationJobRequest withOutputDataConfig(OutputDataConfig outputDataConfig)

Specifies the S3 folder to which your job output will be saved.

Parameters:

outputDataConfig - Specifies the S3 folder to which your job output will be saved.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDataAccessRoleArn

public void setDataAccessRoleArn(String dataAccessRoleArn)

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more information, see identity-and-access-management.

Parameters:

dataAccessRoleArn - The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more information, see identity-and-access-management.

getDataAccessRoleArn

public String getDataAccessRoleArn()

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more information, see identity-and-access-management.

Returns:

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more information, see identity-and-access-management.

withDataAccessRoleArn

public StartTextTranslationJobRequest withDataAccessRoleArn(String dataAccessRoleArn)

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more information, see identity-and-access-management.

Parameters:

dataAccessRoleArn - The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more information, see identity-and-access-management.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSourceLanguageCode

public void setSourceLanguageCode(String sourceLanguageCode)

The language code of the input language. For a list of language codes, see what-is-languages.

Amazon Translate does not automatically detect a source language during batch translation jobs.

Parameters:

sourceLanguageCode - The language code of the input language. For a list of language codes, see what-is-languages.

Amazon Translate does not automatically detect a source language during batch translation jobs.

getSourceLanguageCode

public String getSourceLanguageCode()

The language code of the input language. For a list of language codes, see what-is-languages.

Amazon Translate does not automatically detect a source language during batch translation jobs.

Returns:

The language code of the input language. For a list of language codes, see what-is-languages.

Amazon Translate does not automatically detect a source language during batch translation jobs.

withSourceLanguageCode

public StartTextTranslationJobRequest withSourceLanguageCode(String sourceLanguageCode)

The language code of the input language. For a list of language codes, see what-is-languages.

Amazon Translate does not automatically detect a source language during batch translation jobs.

Parameters:

sourceLanguageCode - The language code of the input language. For a list of language codes, see what-is-languages.

Amazon Translate does not automatically detect a source language during batch translation jobs.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTargetLanguageCodes

public List<String> getTargetLanguageCodes()

The language code of the output language.

Returns:

The language code of the output language.

setTargetLanguageCodes

public void setTargetLanguageCodes(Collection<String> targetLanguageCodes)

The language code of the output language.

Parameters:

targetLanguageCodes - The language code of the output language.

withTargetLanguageCodes

public StartTextTranslationJobRequest withTargetLanguageCodes(String... targetLanguageCodes)

The language code of the output language.

NOTE: This method appends the values to the existing list (if any). Use setTargetLanguageCodes(java.util.Collection) or withTargetLanguageCodes(java.util.Collection) if you want to override the existing values.

Parameters:

targetLanguageCodes - The language code of the output language.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTargetLanguageCodes

public StartTextTranslationJobRequest withTargetLanguageCodes(Collection<String> targetLanguageCodes)

The language code of the output language.

Parameters:

targetLanguageCodes - The language code of the output language.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTerminologyNames

public List<String> getTerminologyNames()

The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

This parameter accepts only one custom terminology resource.

For a list of available custom terminology resources, use the ListTerminologies operation.

For more information, see how-custom-terminology.

Returns:

The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

This parameter accepts only one custom terminology resource.

For a list of available custom terminology resources, use the ListTerminologies operation.

For more information, see how-custom-terminology.

setTerminologyNames

public void setTerminologyNames(Collection<String> terminologyNames)

The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

This parameter accepts only one custom terminology resource.

For a list of available custom terminology resources, use the ListTerminologies operation.

For more information, see how-custom-terminology.

Parameters:

terminologyNames - The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

This parameter accepts only one custom terminology resource.

For a list of available custom terminology resources, use the ListTerminologies operation.

For more information, see how-custom-terminology.

withTerminologyNames

public StartTextTranslationJobRequest withTerminologyNames(String... terminologyNames)

The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

This parameter accepts only one custom terminology resource.

For a list of available custom terminology resources, use the ListTerminologies operation.

For more information, see how-custom-terminology.

NOTE: This method appends the values to the existing list (if any). Use setTerminologyNames(java.util.Collection) or withTerminologyNames(java.util.Collection) if you want to override the existing values.

Parameters:

terminologyNames - The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

This parameter accepts only one custom terminology resource.

For a list of available custom terminology resources, use the ListTerminologies operation.

For more information, see how-custom-terminology.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTerminologyNames

public StartTextTranslationJobRequest withTerminologyNames(Collection<String> terminologyNames)

The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

This parameter accepts only one custom terminology resource.

For a list of available custom terminology resources, use the ListTerminologies operation.

For more information, see how-custom-terminology.

Parameters:

terminologyNames - The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

This parameter accepts only one custom terminology resource.

For a list of available custom terminology resources, use the ListTerminologies operation.

For more information, see how-custom-terminology.

Returns:

Returns a reference to this object so that method calls can be chained together.

getParallelDataNames

public List<String> getParallelDataNames()

The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. When you add parallel data to a translation job, you create an Active Custom Translation job.

This parameter accepts only one parallel data resource.

Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

For a list of available parallel data resources, use the ListParallelData operation.

For more information, see customizing-translations-parallel-data.

Returns:

The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. When you add parallel data to a translation job, you create an Active Custom Translation job.

This parameter accepts only one parallel data resource.

Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

For a list of available parallel data resources, use the ListParallelData operation.

For more information, see customizing-translations-parallel-data.

setParallelDataNames

public void setParallelDataNames(Collection<String> parallelDataNames)

The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. When you add parallel data to a translation job, you create an Active Custom Translation job.

This parameter accepts only one parallel data resource.

Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

For a list of available parallel data resources, use the ListParallelData operation.

For more information, see customizing-translations-parallel-data.

Parameters:

parallelDataNames - The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. When you add parallel data to a translation job, you create an Active Custom Translation job.

This parameter accepts only one parallel data resource.

Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

For a list of available parallel data resources, use the ListParallelData operation.

For more information, see customizing-translations-parallel-data.

withParallelDataNames

public StartTextTranslationJobRequest withParallelDataNames(String... parallelDataNames)

The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. When you add parallel data to a translation job, you create an Active Custom Translation job.

This parameter accepts only one parallel data resource.

Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

For a list of available parallel data resources, use the ListParallelData operation.

For more information, see customizing-translations-parallel-data.

NOTE: This method appends the values to the existing list (if any). Use setParallelDataNames(java.util.Collection) or withParallelDataNames(java.util.Collection) if you want to override the existing values.

Parameters:

parallelDataNames - The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. When you add parallel data to a translation job, you create an Active Custom Translation job.

This parameter accepts only one parallel data resource.

Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

For a list of available parallel data resources, use the ListParallelData operation.

For more information, see customizing-translations-parallel-data.

Returns:

Returns a reference to this object so that method calls can be chained together.

withParallelDataNames

public StartTextTranslationJobRequest withParallelDataNames(Collection<String> parallelDataNames)

The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. When you add parallel data to a translation job, you create an Active Custom Translation job.

This parameter accepts only one parallel data resource.

Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

For a list of available parallel data resources, use the ListParallelData operation.

For more information, see customizing-translations-parallel-data.

Parameters:

parallelDataNames - The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. When you add parallel data to a translation job, you create an Active Custom Translation job.

This parameter accepts only one parallel data resource.

Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

For a list of available parallel data resources, use the ListParallelData operation.

For more information, see customizing-translations-parallel-data.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(String clientToken)

A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.

Parameters:

clientToken - A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.

getClientToken

public String getClientToken()

A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.

Returns:

A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.

withClientToken

public StartTextTranslationJobRequest withClientToken(String clientToken)

A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.

Parameters:

clientToken - A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSettings

public void setSettings(TranslationSettings settings)

Settings to configure your translation output, including the option to mask profane words and phrases.

Parameters:

settings - Settings to configure your translation output, including the option to mask profane words and phrases.

getSettings

public TranslationSettings getSettings()

Settings to configure your translation output, including the option to mask profane words and phrases.

Returns:

Settings to configure your translation output, including the option to mask profane words and phrases.

withSettings

public StartTextTranslationJobRequest withSettings(TranslationSettings settings)

Settings to configure your translation output, including the option to mask profane words and phrases.

Parameters:

settings - Settings to configure your translation output, including the option to mask profane words and phrases.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartTextTranslationJobRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()