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("software.amazon.awssdk:codegen") public final class TranslateTextRequest extends TranslateRequest implements ToCopyableBuilder<TranslateTextRequest.Builder,TranslateTextRequest>

  • Method Details

    • text

      public final 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.

      Returns:
      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.

    • hasTerminologyNames

      public final boolean hasTerminologyNames()
      For responses, this returns true if the service returned a value for the TerminologyNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • terminologyNames

      public final List<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.

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTerminologyNames() method.

      Returns:
      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.

    • sourceLanguageCode

      public final 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.

      Returns:
      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.

    • targetLanguageCode

      public final String targetLanguageCode()

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

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

    • settings

      public final TranslationSettings 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:
      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.

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.