com.amazonaws.services.translate.model

Class TranslateDocumentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.translate.model.TranslateDocumentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TranslateDocumentRequest
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
TranslateDocumentRequest()

Method Summary

Modifier and Type	Method and Description
TranslateDocumentRequest	clone()
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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, 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

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TranslateDocumentRequest

public TranslateDocumentRequest()

Method Detail

setDocument

public void setDocument(Document document)

The content and content type for the document to be translated. The document size must not exceed 100 KB.

Parameters:

document - The content and content type for the document to be translated. The document size must not exceed 100 KB.

getDocument

public Document getDocument()

The content and content type for the document to be translated. The document size must not exceed 100 KB.

Returns:

The content and content type for the document to be translated. The document size must not exceed 100 KB.

withDocument

public TranslateDocumentRequest withDocument(Document document)

The content and content type for the document to be translated. The document size must not exceed 100 KB.

Parameters:

document - The content and content type for the document to be translated. The document size must not exceed 100 KB.

Returns:

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

getTerminologyNames

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.

Returns:

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.

setTerminologyNames

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.

Parameters:

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.

withTerminologyNames

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.

Parameters:

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.

Returns:

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

withTerminologyNames

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.

Parameters:

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.

Returns:

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

setSourceLanguageCode

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.

Parameters:

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.

getSourceLanguageCode

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.

Returns:

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.

withSourceLanguageCode

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.

Parameters:

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.

Returns:

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

setTargetLanguageCode

public void setTargetLanguageCode(String targetLanguageCode)

The language code requested for the translated document. For a list of supported language codes, see Supported languages.

Parameters:

targetLanguageCode - The language code requested for the translated document. For a list of supported language codes, see Supported languages.

getTargetLanguageCode

public String getTargetLanguageCode()

The language code requested for the translated document. For a list of supported language codes, see Supported languages.

Returns:

The language code requested for the translated document. For a list of supported language codes, see Supported languages.

withTargetLanguageCode

public TranslateDocumentRequest withTargetLanguageCode(String targetLanguageCode)

The language code requested for the translated document. For a list of supported language codes, see Supported languages.

Parameters:

targetLanguageCode - The language code requested for the translated document. For a list of supported language codes, see Supported languages.

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. 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.

Parameters:

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.

getSettings

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.

Returns:

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.

withSettings

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.

Parameters:

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.

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 TranslateDocumentRequest clone()

Overrides:

clone in class AmazonWebServiceRequest