software.amazon.awssdk.services.translate.model

Class TranslateDocumentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.translate.model.TranslateRequest

software.amazon.awssdk.services.translate.model.TranslateDocumentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<TranslateDocumentRequest.Builder,TranslateDocumentRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class TranslateDocumentRequest
extends TranslateRequest
implements ToCopyableBuilder<TranslateDocumentRequest.Builder,TranslateDocumentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TranslateDocumentRequest.Builder

Method Summary

Modifier and Type	Method and Description
static TranslateDocumentRequest.Builder	builder()
Document	document() The content and content type for the document to be translated.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTerminologyNames() For responses, this returns true if the service returned a value for the TerminologyNames property.
List<SdkField<?>>	sdkFields()
static Class<? extends TranslateDocumentRequest.Builder>	serializableBuilderClass()
TranslationSettings	settings() Settings to configure your translation output.
String	sourceLanguageCode() The language code for the language of the source text.
String	targetLanguageCode() The language code requested for the translated document.
List<String>	terminologyNames() The name of a terminology list file to add to the translation job.
TranslateDocumentRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

document

public final Document document()

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.

hasTerminologyNames

public final boolean hasTerminologyNames()

For responses, this returns true if the service returned a value for the TerminologyNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

terminologyNames

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTerminologyNames() method.

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.

sourceLanguageCode

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

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.

targetLanguageCode

public final String targetLanguageCode()

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.

settings

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

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.

toBuilder

public TranslateDocumentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TranslateDocumentRequest.Builder,TranslateDocumentRequest>

Specified by:

toBuilder in class TranslateRequest

builder

public static TranslateDocumentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends TranslateDocumentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo