Interface TranslateDocumentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<TranslateDocumentRequest.Builder,TranslateDocumentRequest>, SdkBuilder<TranslateDocumentRequest.Builder,TranslateDocumentRequest>, SdkPojo, SdkRequest.Builder, TranslateRequest.Builder
Enclosing class:
TranslateDocumentRequest
@Mutable @NotThreadSafe public static interface TranslateDocumentRequest.Builder extends TranslateRequest.Builder, SdkPojo, CopyableBuilder<TranslateDocumentRequest.Builder,TranslateDocumentRequest>

  • Method Details

    • document

      TranslateDocumentRequest.Builder document(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.

    • document

      default TranslateDocumentRequest.Builder document(Consumer<Document.Builder> document)

      The content and content type for the document to be translated. The document size must not exceed 100 KB.

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

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

      Parameters:
      document - a consumer that will call methods on Document.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • terminologyNames

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

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

      TranslateDocumentRequest.Builder sourceLanguageCode(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • targetLanguageCode

      TranslateDocumentRequest.Builder targetLanguageCode(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.

    • settings

      TranslateDocumentRequest.Builder settings(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • settings

      default TranslateDocumentRequest.Builder settings(Consumer<TranslationSettings.Builder> 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.

      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:

    • overrideConfiguration

      TranslateDocumentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      TranslateDocumentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.