software.amazon.awssdk.services.translate.model

Interface TranslateTextRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<TranslateTextRequest.Builder,TranslateTextRequest>, SdkBuilder<TranslateTextRequest.Builder,TranslateTextRequest>, SdkPojo, SdkRequest.Builder, TranslateRequest.Builder

Enclosing class:

TranslateTextRequest

public static interface TranslateTextRequest.Builder
extends TranslateRequest.Builder, SdkPojo, CopyableBuilder<TranslateTextRequest.Builder,TranslateTextRequest>

Method Summary

Modifier and Type	Method and Description
TranslateTextRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
TranslateTextRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
default TranslateTextRequest.Builder	settings(Consumer<TranslationSettings.Builder> settings) Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.
TranslateTextRequest.Builder	settings(TranslationSettings settings) Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.
TranslateTextRequest.Builder	sourceLanguageCode(String sourceLanguageCode) The language code for the language of the source text.
TranslateTextRequest.Builder	targetLanguageCode(String targetLanguageCode) The language code requested for the language of the target text.
TranslateTextRequest.Builder	terminologyNames(Collection<String> terminologyNames) The name of a terminology list file to add to the translation job.
TranslateTextRequest.Builder	terminologyNames(String... terminologyNames) The name of a terminology list file to add to the translation job.
TranslateTextRequest.Builder	text(String text) The text to translate.

Methods inherited from interface software.amazon.awssdk.services.translate.model.TranslateRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

text

TranslateTextRequest.Builder text(String text)

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

Parameters:

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

Returns:

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

terminologyNames

TranslateTextRequest.Builder terminologyNames(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.

terminologyNames

TranslateTextRequest.Builder terminologyNames(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.

sourceLanguageCode

TranslateTextRequest.Builder sourceLanguageCode(String sourceLanguageCode)

The language code for the language of the source text. For a list of 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 TranslateText 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 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 TranslateText 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.

targetLanguageCode

TranslateTextRequest.Builder targetLanguageCode(String targetLanguageCode)

The language code requested for the language of the target text. For a list of language codes, see Supported languages.

Parameters:

targetLanguageCode - The language code requested for the language of the target text. For a list of language codes, see Supported languages.

Returns:

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

settings

TranslateTextRequest.Builder settings(TranslationSettings settings)

Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.

Parameters:

settings - Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.

Returns:

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

settings

default TranslateTextRequest.Builder settings(Consumer<TranslationSettings.Builder> settings)

Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.

This is a convenience method that creates an instance of the TranslationSettings.Builder avoiding the need to create one manually via TranslationSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to settings(TranslationSettings).

Parameters:

settings - a consumer that will call methods on TranslationSettings.Builder

Returns:

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

See Also:

settings(TranslationSettings)

overrideConfiguration

TranslateTextRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

TranslateTextRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder