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() 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()
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)
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)
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, 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

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. Do not use auto, because TranslateDocument does not support language auto-detection. For a list of supported language codes, see Supported languages.

Parameters:

sourceLanguageCode - The language code for the language of the source text. Do not use auto, because TranslateDocument does not support language auto-detection. For a list of supported language codes, see Supported languages.

getSourceLanguageCode

public String getSourceLanguageCode()

The language code for the language of the source text. Do not use auto, because TranslateDocument does not support language auto-detection. For a list of supported language codes, see Supported languages.

Returns:

The language code for the language of the source text. Do not use auto, because TranslateDocument does not support language auto-detection. For a list of supported language codes, see Supported languages.

withSourceLanguageCode

public TranslateDocumentRequest withSourceLanguageCode(String sourceLanguageCode)

The language code for the language of the source text. Do not use auto, because TranslateDocument does not support language auto-detection. For a list of supported language codes, see Supported languages.

Parameters:

sourceLanguageCode - The language code for the language of the source text. Do not use auto, because TranslateDocument does not support language auto-detection. 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.

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)

Parameters:

settings -

getSettings

public TranslationSettings getSettings()

Returns:

withSettings

public TranslateDocumentRequest withSettings(TranslationSettings settings)

Parameters:

settings -

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

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