public class TextTranslationJobProperties
extends java.lang.Object
implements java.io.Serializable
Provides information about a translation job.
Constructor and Description |
---|
TextTranslationJobProperties() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getDataAccessRoleArn()
The Amazon Resource Name (ARN) of an AWS Identity Access and Management
(IAM) role that granted Amazon Translate read access to the job's input
data.
|
java.util.Date |
getEndTime()
The time at which the translation job ended.
|
InputDataConfig |
getInputDataConfig()
The input configuration properties that were specified when the job was
requested.
|
JobDetails |
getJobDetails()
The number of documents successfully and unsuccessfully processed during
the translation job.
|
java.lang.String |
getJobId()
The ID of the translation job.
|
java.lang.String |
getJobName()
The user-defined name of the translation job.
|
java.lang.String |
getJobStatus()
The status of the translation job.
|
java.lang.String |
getMessage()
An explanation of any errors that may have occured during the translation
job.
|
OutputDataConfig |
getOutputDataConfig()
The output configuration properties that were specified when the job was
requested.
|
java.util.List<java.lang.String> |
getParallelDataNames()
A list containing the names of the parallel data resources applied to the
translation job.
|
java.lang.String |
getSourceLanguageCode()
The language code of the language of the source text.
|
java.util.Date |
getSubmittedTime()
The time at which the translation job was submitted.
|
java.util.List<java.lang.String> |
getTargetLanguageCodes()
The language code of the language of the target text.
|
java.util.List<java.lang.String> |
getTerminologyNames()
A list containing the names of the terminologies applied to a translation
job.
|
int |
hashCode() |
void |
setDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) of an AWS Identity Access and Management
(IAM) role that granted Amazon Translate read access to the job's input
data.
|
void |
setEndTime(java.util.Date endTime)
The time at which the translation job ended.
|
void |
setInputDataConfig(InputDataConfig inputDataConfig)
The input configuration properties that were specified when the job was
requested.
|
void |
setJobDetails(JobDetails jobDetails)
The number of documents successfully and unsuccessfully processed during
the translation job.
|
void |
setJobId(java.lang.String jobId)
The ID of the translation job.
|
void |
setJobName(java.lang.String jobName)
The user-defined name of the translation job.
|
void |
setJobStatus(JobStatus jobStatus)
The status of the translation job.
|
void |
setJobStatus(java.lang.String jobStatus)
The status of the translation job.
|
void |
setMessage(java.lang.String message)
An explanation of any errors that may have occured during the translation
job.
|
void |
setOutputDataConfig(OutputDataConfig outputDataConfig)
The output configuration properties that were specified when the job was
requested.
|
void |
setParallelDataNames(java.util.Collection<java.lang.String> parallelDataNames)
A list containing the names of the parallel data resources applied to the
translation job.
|
void |
setSourceLanguageCode(java.lang.String sourceLanguageCode)
The language code of the language of the source text.
|
void |
setSubmittedTime(java.util.Date submittedTime)
The time at which the translation job was submitted.
|
void |
setTargetLanguageCodes(java.util.Collection<java.lang.String> targetLanguageCodes)
The language code of the language of the target text.
|
void |
setTerminologyNames(java.util.Collection<java.lang.String> terminologyNames)
A list containing the names of the terminologies applied to a translation
job.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
TextTranslationJobProperties |
withDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) of an AWS Identity Access and Management
(IAM) role that granted Amazon Translate read access to the job's input
data.
|
TextTranslationJobProperties |
withEndTime(java.util.Date endTime)
The time at which the translation job ended.
|
TextTranslationJobProperties |
withInputDataConfig(InputDataConfig inputDataConfig)
The input configuration properties that were specified when the job was
requested.
|
TextTranslationJobProperties |
withJobDetails(JobDetails jobDetails)
The number of documents successfully and unsuccessfully processed during
the translation job.
|
TextTranslationJobProperties |
withJobId(java.lang.String jobId)
The ID of the translation job.
|
TextTranslationJobProperties |
withJobName(java.lang.String jobName)
The user-defined name of the translation job.
|
TextTranslationJobProperties |
withJobStatus(JobStatus jobStatus)
The status of the translation job.
|
TextTranslationJobProperties |
withJobStatus(java.lang.String jobStatus)
The status of the translation job.
|
TextTranslationJobProperties |
withMessage(java.lang.String message)
An explanation of any errors that may have occured during the translation
job.
|
TextTranslationJobProperties |
withOutputDataConfig(OutputDataConfig outputDataConfig)
The output configuration properties that were specified when the job was
requested.
|
TextTranslationJobProperties |
withParallelDataNames(java.util.Collection<java.lang.String> parallelDataNames)
A list containing the names of the parallel data resources applied to the
translation job.
|
TextTranslationJobProperties |
withParallelDataNames(java.lang.String... parallelDataNames)
A list containing the names of the parallel data resources applied to the
translation job.
|
TextTranslationJobProperties |
withSourceLanguageCode(java.lang.String sourceLanguageCode)
The language code of the language of the source text.
|
TextTranslationJobProperties |
withSubmittedTime(java.util.Date submittedTime)
The time at which the translation job was submitted.
|
TextTranslationJobProperties |
withTargetLanguageCodes(java.util.Collection<java.lang.String> targetLanguageCodes)
The language code of the language of the target text.
|
TextTranslationJobProperties |
withTargetLanguageCodes(java.lang.String... targetLanguageCodes)
The language code of the language of the target text.
|
TextTranslationJobProperties |
withTerminologyNames(java.util.Collection<java.lang.String> terminologyNames)
A list containing the names of the terminologies applied to a translation
job.
|
TextTranslationJobProperties |
withTerminologyNames(java.lang.String... terminologyNames)
A list containing the names of the terminologies applied to a translation
job.
|
public java.lang.String getJobId()
The ID of the translation job.
Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
The ID of the translation job.
public void setJobId(java.lang.String jobId)
The ID of the translation job.
Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
jobId
- The ID of the translation job.
public TextTranslationJobProperties withJobId(java.lang.String jobId)
The ID of the translation job.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
jobId
- The ID of the translation job.
public java.lang.String getJobName()
The user-defined name of the translation job.
Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
The user-defined name of the translation job.
public void setJobName(java.lang.String jobName)
The user-defined name of the translation job.
Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
jobName
- The user-defined name of the translation job.
public TextTranslationJobProperties withJobName(java.lang.String jobName)
The user-defined name of the translation job.
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}_.:/=+\-%@]*)$
jobName
- The user-defined name of the translation job.
public java.lang.String getJobStatus()
The status of the translation job.
Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED,
COMPLETED_WITH_ERROR, FAILED, STOP_REQUESTED, STOPPED
The status of the translation job.
JobStatus
public void setJobStatus(java.lang.String jobStatus)
The status of the translation job.
Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED,
COMPLETED_WITH_ERROR, FAILED, STOP_REQUESTED, STOPPED
jobStatus
- The status of the translation job.
JobStatus
public TextTranslationJobProperties withJobStatus(java.lang.String jobStatus)
The status of the translation job.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED,
COMPLETED_WITH_ERROR, FAILED, STOP_REQUESTED, STOPPED
jobStatus
- The status of the translation job.
JobStatus
public void setJobStatus(JobStatus jobStatus)
The status of the translation job.
Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED,
COMPLETED_WITH_ERROR, FAILED, STOP_REQUESTED, STOPPED
jobStatus
- The status of the translation job.
JobStatus
public TextTranslationJobProperties withJobStatus(JobStatus jobStatus)
The status of the translation job.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED,
COMPLETED_WITH_ERROR, FAILED, STOP_REQUESTED, STOPPED
jobStatus
- The status of the translation job.
JobStatus
public JobDetails getJobDetails()
The number of documents successfully and unsuccessfully processed during the translation job.
The number of documents successfully and unsuccessfully processed during the translation job.
public void setJobDetails(JobDetails jobDetails)
The number of documents successfully and unsuccessfully processed during the translation job.
jobDetails
- The number of documents successfully and unsuccessfully processed during the translation job.
public TextTranslationJobProperties withJobDetails(JobDetails jobDetails)
The number of documents successfully and unsuccessfully processed during the translation job.
Returns a reference to this object so that method calls can be chained together.
jobDetails
- The number of documents successfully and unsuccessfully processed during the translation job.
public java.lang.String getSourceLanguageCode()
The language code of the language of the source text. The language must be a language supported by Amazon Translate.
Constraints:
Length: 2 - 5
The language code of the language of the source text. The language must be a language supported by Amazon Translate.
public void setSourceLanguageCode(java.lang.String sourceLanguageCode)
The language code of the language of the source text. The language must be a language supported by Amazon Translate.
Constraints:
Length: 2 - 5
sourceLanguageCode
- The language code of the language of the source text. The language must be a language supported by Amazon Translate.
public TextTranslationJobProperties withSourceLanguageCode(java.lang.String sourceLanguageCode)
The language code of the language of the source text. The language must be a language supported by Amazon Translate.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 2 - 5
sourceLanguageCode
- The language code of the language of the source text. The language must be a language supported by Amazon Translate.
public java.util.List<java.lang.String> getTargetLanguageCodes()
The language code of the language of the target text. The language must be a language supported by Amazon Translate.
The language code of the language of the target text. The language must be a language supported by Amazon Translate.
public void setTargetLanguageCodes(java.util.Collection<java.lang.String> targetLanguageCodes)
The language code of the language of the target text. The language must be a language supported by Amazon Translate.
targetLanguageCodes
- The language code of the language of the target text. The language must be a language supported by Amazon Translate.
public TextTranslationJobProperties withTargetLanguageCodes(java.lang.String... targetLanguageCodes)
The language code of the language of the target text. The language must be a language supported by Amazon Translate.
Returns a reference to this object so that method calls can be chained together.
targetLanguageCodes
- The language code of the language of the target text. The language must be a language supported by Amazon Translate.
public TextTranslationJobProperties withTargetLanguageCodes(java.util.Collection<java.lang.String> targetLanguageCodes)
The language code of the language of the target text. The language must be a language supported by Amazon Translate.
Returns a reference to this object so that method calls can be chained together.
targetLanguageCodes
- The language code of the language of the target text. The language must be a language supported by Amazon Translate.
public java.util.List<java.lang.String> getTerminologyNames()
A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.
A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.
public void setTerminologyNames(java.util.Collection<java.lang.String> terminologyNames)
A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.
terminologyNames
- A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.
public TextTranslationJobProperties withTerminologyNames(java.lang.String... terminologyNames)
A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.
Returns a reference to this object so that method calls can be chained together.
terminologyNames
- A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.
public TextTranslationJobProperties withTerminologyNames(java.util.Collection<java.lang.String> terminologyNames)
A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.
Returns a reference to this object so that method calls can be chained together.
terminologyNames
- A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.
public java.util.List<java.lang.String> getParallelDataNames()
A list containing the names of the parallel data resources applied to the translation job.
A list containing the names of the parallel data resources applied to the translation job.
public void setParallelDataNames(java.util.Collection<java.lang.String> parallelDataNames)
A list containing the names of the parallel data resources applied to the translation job.
parallelDataNames
- A list containing the names of the parallel data resources applied to the translation job.
public TextTranslationJobProperties withParallelDataNames(java.lang.String... parallelDataNames)
A list containing the names of the parallel data resources applied to the translation job.
Returns a reference to this object so that method calls can be chained together.
parallelDataNames
- A list containing the names of the parallel data resources applied to the translation job.
public TextTranslationJobProperties withParallelDataNames(java.util.Collection<java.lang.String> parallelDataNames)
A list containing the names of the parallel data resources applied to the translation job.
Returns a reference to this object so that method calls can be chained together.
parallelDataNames
- A list containing the names of the parallel data resources applied to the translation job.
public java.lang.String getMessage()
An explanation of any errors that may have occured during the translation job.
An explanation of any errors that may have occured during the translation job.
public void setMessage(java.lang.String message)
An explanation of any errors that may have occured during the translation job.
message
- An explanation of any errors that may have occured during the translation job.
public TextTranslationJobProperties withMessage(java.lang.String message)
An explanation of any errors that may have occured during the translation job.
Returns a reference to this object so that method calls can be chained together.
message
- An explanation of any errors that may have occured during the translation job.
public java.util.Date getSubmittedTime()
The time at which the translation job was submitted.
The time at which the translation job was submitted.
public void setSubmittedTime(java.util.Date submittedTime)
The time at which the translation job was submitted.
submittedTime
- The time at which the translation job was submitted.
public TextTranslationJobProperties withSubmittedTime(java.util.Date submittedTime)
The time at which the translation job was submitted.
Returns a reference to this object so that method calls can be chained together.
submittedTime
- The time at which the translation job was submitted.
public java.util.Date getEndTime()
The time at which the translation job ended.
The time at which the translation job ended.
public void setEndTime(java.util.Date endTime)
The time at which the translation job ended.
endTime
- The time at which the translation job ended.
public TextTranslationJobProperties withEndTime(java.util.Date endTime)
The time at which the translation job ended.
Returns a reference to this object so that method calls can be chained together.
endTime
- The time at which the translation job ended.
public InputDataConfig getInputDataConfig()
The input configuration properties that were specified when the job was requested.
The input configuration properties that were specified when the job was requested.
public void setInputDataConfig(InputDataConfig inputDataConfig)
The input configuration properties that were specified when the job was requested.
inputDataConfig
- The input configuration properties that were specified when the job was requested.
public TextTranslationJobProperties withInputDataConfig(InputDataConfig inputDataConfig)
The input configuration properties that were specified when the job was requested.
Returns a reference to this object so that method calls can be chained together.
inputDataConfig
- The input configuration properties that were specified when the job was requested.
public OutputDataConfig getOutputDataConfig()
The output configuration properties that were specified when the job was requested.
The output configuration properties that were specified when the job was requested.
public void setOutputDataConfig(OutputDataConfig outputDataConfig)
The output configuration properties that were specified when the job was requested.
outputDataConfig
- The output configuration properties that were specified when the job was requested.
public TextTranslationJobProperties withOutputDataConfig(OutputDataConfig outputDataConfig)
The output configuration properties that were specified when the job was requested.
Returns a reference to this object so that method calls can be chained together.
outputDataConfig
- The output configuration properties that were specified when the job was requested.
public java.lang.String getDataAccessRoleArn()
The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.
Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.
public void setDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.
Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
dataAccessRoleArn
- The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.
public TextTranslationJobProperties withDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.
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/.+
dataAccessRoleArn
- The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.