StartTextTranslationJobRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.translate.model.StartTextTranslationJobRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class StartTextTranslationJobRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Starts an asynchronous batch translation job. Batch translation jobs can be used to translate large volumes of text across multiple documents at once. For more information, see async.

Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation.

Amazon Translate does not support batch translation of multiple source languages at once.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

StartTextTranslationJobRequest()

Constructors
Constructor and Description
`StartTextTranslationJobRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getClientToken()` A unique identifier for the request.
`java.lang.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.
`java.lang.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.
`java.util.List<java.lang.String>`	`getParallelDataNames()` The names of the parallel data resources to use in the batch translation job.
`java.lang.String`	`getSourceLanguageCode()` The language code of the input language.
`java.util.List<java.lang.String>`	`getTargetLanguageCodes()` The language code of the output language.
`java.util.List<java.lang.String>`	`getTerminologyNames()` The name of the terminology to use in the batch translation job.
`int`	`hashCode()`
`void`	`setClientToken(java.lang.String clientToken)` A unique identifier for the request.
`void`	`setDataAccessRoleArn(java.lang.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(java.lang.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(java.util.Collection<java.lang.String> parallelDataNames)` The names of the parallel data resources to use in the batch translation job.
`void`	`setSourceLanguageCode(java.lang.String sourceLanguageCode)` The language code of the input language.
`void`	`setTargetLanguageCodes(java.util.Collection<java.lang.String> targetLanguageCodes)` The language code of the output language.
`void`	`setTerminologyNames(java.util.Collection<java.lang.String> terminologyNames)` The name of the terminology to use in the batch translation job.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`StartTextTranslationJobRequest`	`withClientToken(java.lang.String clientToken)` A unique identifier for the request.
`StartTextTranslationJobRequest`	`withDataAccessRoleArn(java.lang.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(java.lang.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(java.util.Collection<java.lang.String> parallelDataNames)` The names of the parallel data resources to use in the batch translation job.
`StartTextTranslationJobRequest`	`withParallelDataNames(java.lang.String... parallelDataNames)` The names of the parallel data resources to use in the batch translation job.
`StartTextTranslationJobRequest`	`withSourceLanguageCode(java.lang.String sourceLanguageCode)` The language code of the input language.
`StartTextTranslationJobRequest`	`withTargetLanguageCodes(java.util.Collection<java.lang.String> targetLanguageCodes)` The language code of the output language.
`StartTextTranslationJobRequest`	`withTargetLanguageCodes(java.lang.String... targetLanguageCodes)` The language code of the output language.
`StartTextTranslationJobRequest`	`withTerminologyNames(java.util.Collection<java.lang.String> terminologyNames)` The name of the terminology to use in the batch translation job.
`StartTextTranslationJobRequest`	`withTerminologyNames(java.lang.String... terminologyNames)` The name of the terminology to use in the batch translation job.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StartTextTranslationJobRequest
```
public StartTextTranslationJobRequest()
```
- Method Detail
  - getJobName
```
public java.lang.String getJobName()
```
    The name of the batch translation job to be performed.
    
    Constraints:
    Length: 1 - 256
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Returns:
    
    The name of the batch translation job to be performed.
  - setJobName
```
public void setJobName(java.lang.String jobName)
```
    The name of the batch translation job to be performed.
    
    Constraints:
    Length: 1 - 256
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Parameters:
    
    jobName -
    The name of the batch translation job to be performed.
  - withJobName
```
public StartTextTranslationJobRequest withJobName(java.lang.String jobName)
```
    The name of the batch translation job to be performed.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Parameters:
    
    jobName -
    The name of the batch translation job to be performed.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withInputDataConfig
```
public StartTextTranslationJobRequest withInputDataConfig(InputDataConfig inputDataConfig)
```
    Specifies the format and S3 location of the input documents for the translation job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    inputDataConfig -
    Specifies the format and S3 location of the input documents for the translation job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withOutputDataConfig
```
public StartTextTranslationJobRequest withOutputDataConfig(OutputDataConfig outputDataConfig)
```
    Specifies the S3 folder to which your job output will be saved.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    outputDataConfig -
    Specifies the S3 folder to which your job output will be saved.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDataAccessRoleArn
```
public java.lang.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 nformation, see identity-and-access-management.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
    
    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 nformation, see identity-and-access-management.
  - setDataAccessRoleArn
```
public void setDataAccessRoleArn(java.lang.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 nformation, see identity-and-access-management.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
    
    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 nformation, see identity-and-access-management.
  - withDataAccessRoleArn
```
public StartTextTranslationJobRequest withDataAccessRoleArn(java.lang.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 nformation, see identity-and-access-management.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
    
    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 nformation, see identity-and-access-management.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSourceLanguageCode
```
public java.lang.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.
    
    Constraints:
    Length: 2 - 5
    
    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.
  - setSourceLanguageCode
```
public void setSourceLanguageCode(java.lang.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.
    
    Constraints:
    Length: 2 - 5
    
    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.
  - withSourceLanguageCode
```
public StartTextTranslationJobRequest withSourceLanguageCode(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 2 - 5
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getTargetLanguageCodes
```
public java.util.List<java.lang.String> getTargetLanguageCodes()
```
    The language code of the output language.
    
    Returns:
    
    The language code of the output language.
  - setTargetLanguageCodes
```
public void setTargetLanguageCodes(java.util.Collection<java.lang.String> targetLanguageCodes)
```
    The language code of the output language.
    
    Parameters:
    
    targetLanguageCodes -
    The language code of the output language.
  - withTargetLanguageCodes
```
public StartTextTranslationJobRequest withTargetLanguageCodes(java.lang.String... targetLanguageCodes)
```
    The language code of the output language.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    targetLanguageCodes -
    The language code of the output language.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withTargetLanguageCodes
```
public StartTextTranslationJobRequest withTargetLanguageCodes(java.util.Collection<java.lang.String> targetLanguageCodes)
```
    The language code of the output language.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    targetLanguageCodes -
    The language code of the output language.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTerminologyNames
```
public java.util.List<java.lang.String> getTerminologyNames()
```
    The name of the terminology to use in the batch translation job. For a list of available terminologies, use the ListTerminologies operation.
    
    Returns:
    
    The name of the terminology to use in the batch translation job. For a list of available terminologies, use the ListTerminologies operation.
  - setTerminologyNames
```
public void setTerminologyNames(java.util.Collection<java.lang.String> terminologyNames)
```
    The name of the terminology to use in the batch translation job. For a list of available terminologies, use the ListTerminologies operation.
    
    Parameters:
    
    terminologyNames -
    The name of the terminology to use in the batch translation job. For a list of available terminologies, use the ListTerminologies operation.
  - withTerminologyNames
```
public StartTextTranslationJobRequest withTerminologyNames(java.lang.String... terminologyNames)
```
    The name of the terminology to use in the batch translation job. For a list of available terminologies, use the ListTerminologies operation.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    terminologyNames -
    The name of the terminology to use in the batch translation job. For a list of available terminologies, use the ListTerminologies operation.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withTerminologyNames
```
public StartTextTranslationJobRequest withTerminologyNames(java.util.Collection<java.lang.String> terminologyNames)
```
    The name of the terminology to use in the batch translation job. For a list of available terminologies, use the ListTerminologies operation.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    terminologyNames -
    The name of the terminology to use in the batch translation job. For a list of available terminologies, use the ListTerminologies operation.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getParallelDataNames
```
public java.util.List<java.lang.String> getParallelDataNames()
```
    The names of the parallel data resources to use in the batch translation job. For a list of available parallel data resources, use the ListParallelData operation.
    
    Returns:
    
    The names of the parallel data resources to use in the batch translation job. For a list of available parallel data resources, use the ListParallelData operation.
  - setParallelDataNames
```
public void setParallelDataNames(java.util.Collection<java.lang.String> parallelDataNames)
```
    The names of the parallel data resources to use in the batch translation job. For a list of available parallel data resources, use the ListParallelData operation.
    
    Parameters:
    
    parallelDataNames -
    The names of the parallel data resources to use in the batch translation job. For a list of available parallel data resources, use the ListParallelData operation.
  - withParallelDataNames
```
public StartTextTranslationJobRequest withParallelDataNames(java.lang.String... parallelDataNames)
```
    The names of the parallel data resources to use in the batch translation job. For a list of available parallel data resources, use the ListParallelData operation.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    parallelDataNames -
    The names of the parallel data resources to use in the batch translation job. For a list of available parallel data resources, use the ListParallelData operation.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withParallelDataNames
```
public StartTextTranslationJobRequest withParallelDataNames(java.util.Collection<java.lang.String> parallelDataNames)
```
    The names of the parallel data resources to use in the batch translation job. For a list of available parallel data resources, use the ListParallelData operation.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    parallelDataNames -
    The names of the parallel data resources to use in the batch translation job. For a list of available parallel data resources, use the ListParallelData operation.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientToken
```
public java.lang.String getClientToken()
```
    A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.
    
    Constraints:
    Length: 1 - 64
    Pattern: ^[a-zA-Z0-9-]+$
    
    Returns:
    
    A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.
  - setClientToken
```
public void setClientToken(java.lang.String clientToken)
```
    A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.
    
    Constraints:
    Length: 1 - 64
    Pattern: ^[a-zA-Z0-9-]+$
    
    Parameters:
    
    clientToken -
    A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.
  - withClientToken
```
public StartTextTranslationJobRequest withClientToken(java.lang.String clientToken)
```
    A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: ^[a-zA-Z0-9-]+$
    
    Parameters:
    
    clientToken -
    A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class StartTextTranslationJobRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

StartTextTranslationJobRequest

Method Detail

getJobName

setJobName

withJobName

getInputDataConfig

setInputDataConfig

withInputDataConfig

getOutputDataConfig

setOutputDataConfig

withOutputDataConfig

getDataAccessRoleArn

setDataAccessRoleArn

withDataAccessRoleArn

getSourceLanguageCode

setSourceLanguageCode

withSourceLanguageCode

getTargetLanguageCodes

setTargetLanguageCodes

withTargetLanguageCodes

withTargetLanguageCodes

getTerminologyNames

setTerminologyNames

withTerminologyNames

withTerminologyNames

getParallelDataNames

setParallelDataNames

withParallelDataNames

withParallelDataNames

getClientToken

setClientToken

withClientToken

toString

hashCode

equals