Package software.amazon.awssdk.services.translate.model

Interface StartTextTranslationJobRequest.Builder

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

  • Method Details

    • jobName

      StartTextTranslationJobRequest.Builder jobName(String jobName)

      The name of the batch translation job to be performed.

      Parameters:
      jobName - The name of the batch translation job to be performed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataConfig

      StartTextTranslationJobRequest.Builder inputDataConfig(InputDataConfig inputDataConfig)

      Specifies the format and location of the input documents for the translation job.

      Parameters:
      inputDataConfig - Specifies the format and location of the input documents for the translation job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataConfig

      default StartTextTranslationJobRequest.Builder inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig)

      Specifies the format and location of the input documents for the translation job.

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

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

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

    • outputDataConfig

      StartTextTranslationJobRequest.Builder outputDataConfig(OutputDataConfig outputDataConfig)

      Specifies the S3 folder to which your job output will be saved.

      Parameters:
      outputDataConfig - Specifies the S3 folder to which your job output will be saved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputDataConfig

      default StartTextTranslationJobRequest.Builder outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig)

      Specifies the S3 folder to which your job output will be saved.

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

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

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

    • dataAccessRoleArn

      StartTextTranslationJobRequest.Builder dataAccessRoleArn(String dataAccessRoleArn)

      The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more information, see Identity and access management .

      Parameters:
      dataAccessRoleArn - The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more information, see Identity and access management .
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceLanguageCode

      StartTextTranslationJobRequest.Builder sourceLanguageCode(String sourceLanguageCode)

      The language code of the input language. Specify the language if all input documents share the same language. If you don't know the language of the source files, or your input documents contains different source languages, select auto. Amazon Translate auto detects the source language for each input document. For a list of supported language codes, see Supported languages.

      Parameters:
      sourceLanguageCode - The language code of the input language. Specify the language if all input documents share the same language. If you don't know the language of the source files, or your input documents contains different source languages, select auto. Amazon Translate auto detects the source language for each input 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.

    • targetLanguageCodes

      StartTextTranslationJobRequest.Builder targetLanguageCodes(Collection<String> targetLanguageCodes)

      The target languages of the translation job. Enter up to 10 language codes. Each input file is translated into each target language.

      Each language code is 2 or 5 characters long. For a list of language codes, see Supported languages.

      Parameters:
      targetLanguageCodes - The target languages of the translation job. Enter up to 10 language codes. Each input file is translated into each target language.

      Each language code is 2 or 5 characters long. For a list of language codes, see Supported languages.

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

    • targetLanguageCodes

      StartTextTranslationJobRequest.Builder targetLanguageCodes(String... targetLanguageCodes)

      The target languages of the translation job. Enter up to 10 language codes. Each input file is translated into each target language.

      Each language code is 2 or 5 characters long. For a list of language codes, see Supported languages.

      Parameters:
      targetLanguageCodes - The target languages of the translation job. Enter up to 10 language codes. Each input file is translated into each target language.

      Each language code is 2 or 5 characters long. For a list of language codes, see Supported languages.

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

    • terminologyNames

      StartTextTranslationJobRequest.Builder terminologyNames(Collection<String> terminologyNames)

      The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

      This parameter accepts only one custom terminology resource.

      If you specify multiple target languages for the job, translate uses the designated terminology for each requested target language that has an entry for the source term in the terminology file.

      For a list of available custom terminology resources, use the ListTerminologies operation.

      For more information, see Custom terminology.

      Parameters:
      terminologyNames - The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

      This parameter accepts only one custom terminology resource.

      If you specify multiple target languages for the job, translate uses the designated terminology for each requested target language that has an entry for the source term in the terminology file.

      For a list of available custom terminology resources, use the ListTerminologies operation.

      For more information, see Custom terminology.

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

    • terminologyNames

      StartTextTranslationJobRequest.Builder terminologyNames(String... terminologyNames)

      The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

      This parameter accepts only one custom terminology resource.

      If you specify multiple target languages for the job, translate uses the designated terminology for each requested target language that has an entry for the source term in the terminology file.

      For a list of available custom terminology resources, use the ListTerminologies operation.

      For more information, see Custom terminology.

      Parameters:
      terminologyNames - The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

      This parameter accepts only one custom terminology resource.

      If you specify multiple target languages for the job, translate uses the designated terminology for each requested target language that has an entry for the source term in the terminology file.

      For a list of available custom terminology resources, use the ListTerminologies operation.

      For more information, see Custom terminology.

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

    • parallelDataNames

      StartTextTranslationJobRequest.Builder parallelDataNames(Collection<String> parallelDataNames)

      The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. If you specify multiple target languages for the job, the parallel data file must include translations for all the target languages.

      When you add parallel data to a translation job, you create an Active Custom Translation job.

      This parameter accepts only one parallel data resource.

      Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

      For a list of available parallel data resources, use the ListParallelData operation.

      For more information, see Customizing your translations with parallel data.

      Parameters:
      parallelDataNames - The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. If you specify multiple target languages for the job, the parallel data file must include translations for all the target languages.

      When you add parallel data to a translation job, you create an Active Custom Translation job.

      This parameter accepts only one parallel data resource.

      Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

      For a list of available parallel data resources, use the ListParallelData operation.

      For more information, see Customizing your translations with parallel data.

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

    • parallelDataNames

      StartTextTranslationJobRequest.Builder parallelDataNames(String... parallelDataNames)

      The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. If you specify multiple target languages for the job, the parallel data file must include translations for all the target languages.

      When you add parallel data to a translation job, you create an Active Custom Translation job.

      This parameter accepts only one parallel data resource.

      Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

      For a list of available parallel data resources, use the ListParallelData operation.

      For more information, see Customizing your translations with parallel data.

      Parameters:
      parallelDataNames - The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. If you specify multiple target languages for the job, the parallel data file must include translations for all the target languages.

      When you add parallel data to a translation job, you create an Active Custom Translation job.

      This parameter accepts only one parallel data resource.

      Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

      For a list of available parallel data resources, use the ListParallelData operation.

      For more information, see Customizing your translations with parallel data.

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

    • clientToken

      StartTextTranslationJobRequest.Builder clientToken(String clientToken)

      A unique identifier for the request. This token is generated for you when using the Amazon Translate SDK.

      Parameters:
      clientToken - A unique identifier for the request. This token is generated for you when using the Amazon Translate SDK.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • settings

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

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

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