@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class TranslateDocumentRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
TranslateDocumentRequest() |
Modifier and Type | Method and Description |
---|---|
TranslateDocumentRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Document |
getDocument()
The content and content type for the document to be translated.
|
TranslationSettings |
getSettings()
Settings to configure your translation output.
|
String |
getSourceLanguageCode()
The language code for the language of the source text.
|
String |
getTargetLanguageCode()
The language code requested for the translated document.
|
List<String> |
getTerminologyNames()
The name of a terminology list file to add to the translation job.
|
int |
hashCode() |
void |
setDocument(Document document)
The content and content type for the document to be translated.
|
void |
setSettings(TranslationSettings settings)
Settings to configure your translation output.
|
void |
setSourceLanguageCode(String sourceLanguageCode)
The language code for the language of the source text.
|
void |
setTargetLanguageCode(String targetLanguageCode)
The language code requested for the translated document.
|
void |
setTerminologyNames(Collection<String> terminologyNames)
The name of a terminology list file to add to the translation job.
|
String |
toString()
Returns a string representation of this object.
|
TranslateDocumentRequest |
withDocument(Document document)
The content and content type for the document to be translated.
|
TranslateDocumentRequest |
withSettings(TranslationSettings settings)
Settings to configure your translation output.
|
TranslateDocumentRequest |
withSourceLanguageCode(String sourceLanguageCode)
The language code for the language of the source text.
|
TranslateDocumentRequest |
withTargetLanguageCode(String targetLanguageCode)
The language code requested for the translated document.
|
TranslateDocumentRequest |
withTerminologyNames(Collection<String> terminologyNames)
The name of a terminology list file to add to the translation job.
|
TranslateDocumentRequest |
withTerminologyNames(String... terminologyNames)
The name of a terminology list file to add to the translation job.
|
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
public void setDocument(Document document)
The content and content type for the document to be translated. The document size must not exceed 100 KB.
document
- The content and content type for the document to be translated. The document size must not exceed 100 KB.public Document getDocument()
The content and content type for the document to be translated. The document size must not exceed 100 KB.
public TranslateDocumentRequest withDocument(Document document)
The content and content type for the document to be translated. The document size must not exceed 100 KB.
document
- The content and content type for the document to be translated. The document size must not exceed 100 KB.public List<String> getTerminologyNames()
The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.
Use the ListTerminologies operation to get the available terminology lists.
For more information about custom terminology lists, see Custom terminology.
Use the ListTerminologies operation to get the available terminology lists.
For more information about custom terminology lists, see Custom terminology.
public void setTerminologyNames(Collection<String> terminologyNames)
The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.
Use the ListTerminologies operation to get the available terminology lists.
For more information about custom terminology lists, see Custom terminology.
terminologyNames
- The name of a terminology list file to add to the translation job. This file provides source terms and the
desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one
custom terminology resource in your translation request.
Use the ListTerminologies operation to get the available terminology lists.
For more information about custom terminology lists, see Custom terminology.
public TranslateDocumentRequest withTerminologyNames(String... terminologyNames)
The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.
Use the ListTerminologies operation to get the available terminology lists.
For more information about custom terminology lists, see 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.
terminologyNames
- The name of a terminology list file to add to the translation job. This file provides source terms and the
desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one
custom terminology resource in your translation request.
Use the ListTerminologies operation to get the available terminology lists.
For more information about custom terminology lists, see Custom terminology.
public TranslateDocumentRequest withTerminologyNames(Collection<String> terminologyNames)
The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.
Use the ListTerminologies operation to get the available terminology lists.
For more information about custom terminology lists, see Custom terminology.
terminologyNames
- The name of a terminology list file to add to the translation job. This file provides source terms and the
desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one
custom terminology resource in your translation request.
Use the ListTerminologies operation to get the available terminology lists.
For more information about custom terminology lists, see Custom terminology.
public void setSourceLanguageCode(String sourceLanguageCode)
The language code for the language of the source text. For a list of supported language codes, see Supported languages.
To have Amazon Translate determine the source language of your text, you can specify auto
in the
SourceLanguageCode
field. If you specify auto
, Amazon Translate will call Amazon Comprehend to
determine the source language.
If you specify auto
, you must send the TranslateDocument
request in a region that
supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.
sourceLanguageCode
- The language code for the language of the source text. For a list of supported language codes, see Supported languages.
To have Amazon Translate determine the source language of your text, you can specify auto
in
the SourceLanguageCode
field. If you specify auto
, Amazon Translate will call Amazon Comprehend to
determine the source language.
If you specify auto
, you must send the TranslateDocument
request in a region
that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not
supported.
public String getSourceLanguageCode()
The language code for the language of the source text. For a list of supported language codes, see Supported languages.
To have Amazon Translate determine the source language of your text, you can specify auto
in the
SourceLanguageCode
field. If you specify auto
, Amazon Translate will call Amazon Comprehend to
determine the source language.
If you specify auto
, you must send the TranslateDocument
request in a region that
supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.
To have Amazon Translate determine the source language of your text, you can specify auto
in
the SourceLanguageCode
field. If you specify auto
, Amazon Translate will call
Amazon Comprehend
to determine the source language.
If you specify auto
, you must send the TranslateDocument
request in a region
that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is
not supported.
public TranslateDocumentRequest withSourceLanguageCode(String sourceLanguageCode)
The language code for the language of the source text. For a list of supported language codes, see Supported languages.
To have Amazon Translate determine the source language of your text, you can specify auto
in the
SourceLanguageCode
field. If you specify auto
, Amazon Translate will call Amazon Comprehend to
determine the source language.
If you specify auto
, you must send the TranslateDocument
request in a region that
supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.
sourceLanguageCode
- The language code for the language of the source text. For a list of supported language codes, see Supported languages.
To have Amazon Translate determine the source language of your text, you can specify auto
in
the SourceLanguageCode
field. If you specify auto
, Amazon Translate will call Amazon Comprehend to
determine the source language.
If you specify auto
, you must send the TranslateDocument
request in a region
that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not
supported.
public void setTargetLanguageCode(String targetLanguageCode)
The language code requested for the translated document. For a list of supported language codes, see Supported languages.
targetLanguageCode
- The language code requested for the translated document. For a list of supported language codes, see Supported languages.public String getTargetLanguageCode()
The language code requested for the translated document. For a list of supported language codes, see Supported languages.
public TranslateDocumentRequest withTargetLanguageCode(String targetLanguageCode)
The language code requested for the translated document. For a list of supported language codes, see Supported languages.
targetLanguageCode
- The language code requested for the translated document. For a list of supported language codes, see Supported languages.public void setSettings(TranslationSettings settings)
Settings to configure your translation output. You can configure the following options:
Brevity: not supported.
Formality: sets the formality level of the output text.
Profanity: masks profane words and phrases in your translation output.
settings
- Settings to configure your translation output. You can configure the following options:
Brevity: not supported.
Formality: sets the formality level of the output text.
Profanity: masks profane words and phrases in your translation output.
public TranslationSettings getSettings()
Settings to configure your translation output. You can configure the following options:
Brevity: not supported.
Formality: sets the formality level of the output text.
Profanity: masks profane words and phrases in your translation output.
Brevity: not supported.
Formality: sets the formality level of the output text.
Profanity: masks profane words and phrases in your translation output.
public TranslateDocumentRequest withSettings(TranslationSettings settings)
Settings to configure your translation output. You can configure the following options:
Brevity: not supported.
Formality: sets the formality level of the output text.
Profanity: masks profane words and phrases in your translation output.
settings
- Settings to configure your translation output. You can configure the following options:
Brevity: not supported.
Formality: sets the formality level of the output text.
Profanity: masks profane words and phrases in your translation output.
public String toString()
toString
in class Object
Object.toString()
public TranslateDocumentRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()