software.amazon.awssdk.services.translate.model

Class TranslateTextRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<TranslateTextRequest.Builder,TranslateTextRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TranslateTextRequest.Builder

Method Summary

Modifier and Type	Method and Description
static TranslateTextRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasTerminologyNames() Returns true if the TerminologyNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<SdkField<?>>	sdkFields()
static Class<? extends TranslateTextRequest.Builder>	serializableBuilderClass()
String	sourceLanguageCode() The language code for the language of the source text.
String	targetLanguageCode() The language code requested for the language of the target text.
List<String>	terminologyNames() The name of the terminology list file to be used in the TranslateText request.
String	text() The text to translate.
TranslateTextRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

text

public final String text()

The text to translate. The text string can be a maximum of 5,000 bytes long. Depending on your character set, this may be fewer than 5,000 characters.

Returns:

The text to translate. The text string can be a maximum of 5,000 bytes long. Depending on your character set, this may be fewer than 5,000 characters.

hasTerminologyNames

public final boolean hasTerminologyNames()

Returns true if the TerminologyNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

terminologyNames

public final List<String> terminologyNames()

The name of the terminology list file to be used in the TranslateText request. You can use 1 terminology list at most in a TranslateText request. Terminology lists can contain a maximum of 256 terms.

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

You can use hasTerminologyNames() to see if a value was sent in this field.

Returns:

The name of the terminology list file to be used in the TranslateText request. You can use 1 terminology list at most in a TranslateText request. Terminology lists can contain a maximum of 256 terms.

sourceLanguageCode

public final String sourceLanguageCode()

The language code for the language of the source text. The language must be a language supported by Amazon Translate. For a list of language codes, see what-is-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.

Returns:

The language code for the language of the source text. The language must be a language supported by Amazon Translate. For a list of language codes, see what-is-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.

targetLanguageCode

public final String targetLanguageCode()

The language code requested for the language of the target text. The language must be a language supported by Amazon Translate.

Returns:

The language code requested for the language of the target text. The language must be a language supported by Amazon Translate.

toBuilder

public TranslateTextRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<TranslateTextRequest.Builder,TranslateTextRequest>

Specified by:

toBuilder in class TranslateRequest

Returns:

a builder for type T

builder

public static TranslateTextRequest.Builder builder()

serializableBuilderClass

public static Class<? extends TranslateTextRequest.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.