Interface TranslateTextRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<TranslateTextRequest.Builder,
,TranslateTextRequest> SdkBuilder<TranslateTextRequest.Builder,
,TranslateTextRequest> SdkPojo
,SdkRequest.Builder
,TranslateRequest.Builder
- Enclosing class:
TranslateTextRequest
-
Method Summary
Modifier and TypeMethodDescriptionoverrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default TranslateTextRequest.Builder
settings
(Consumer<TranslationSettings.Builder> settings) Settings to configure your translation output.settings
(TranslationSettings settings) Settings to configure your translation output.sourceLanguageCode
(String sourceLanguageCode) The language code for the language of the source text.targetLanguageCode
(String targetLanguageCode) The language code requested for the language of the target text.terminologyNames
(String... terminologyNames) The name of a terminology list file to add to the translation job.terminologyNames
(Collection<String> terminologyNames) The name of a terminology list file to add to the translation job.The text to translate.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.translate.model.TranslateRequest.Builder
build
-
Method Details
-
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
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
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
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 theSourceLanguageCode
field. If you specifyauto
, Amazon Translate will call Amazon Comprehend to determine the source language.If you specify
auto
, you must send theTranslateText
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 theSourceLanguageCode
field. If you specifyauto
, Amazon Translate will call Amazon Comprehend to determine the source language.If you specify
auto
, you must send theTranslateText
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
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
Settings to configure your translation output. You can configure the following options:
-
Brevity: reduces the length of the translated output for most translations.
-
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: reduces the length of the translated output for most translations.
-
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.
-
-
settings
Settings to configure your translation output. You can configure the following options:
-
Brevity: reduces the length of the translated output for most translations.
-
Formality: sets the formality level of the output text.
-
Profanity: masks profane words and phrases in your translation output.
TranslationSettings.Builder
avoiding the need to create one manually viaTranslationSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosettings(TranslationSettings)
.- Parameters:
settings
- a consumer that will call methods onTranslationSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
overrideConfiguration
TranslateTextRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
TranslateTextRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-