Class TerminologyData

java.lang.Object
software.amazon.awssdk.services.translate.model.TerminologyData
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TerminologyData.Builder,TerminologyData>
@Generated("software.amazon.awssdk:codegen") public final class TerminologyData extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TerminologyData.Builder,TerminologyData>

The data associated with the custom terminology. For information about the custom terminology file, see Creating a Custom Terminology.

See Also:

  • Method Details

    • file

      public final SdkBytes file()

      The file containing the custom terminology data. Your version of the AWS SDK performs a Base64-encoding on this field before sending a request to the AWS service. Users of the SDK should not perform Base64-encoding themselves.

      Returns:
      The file containing the custom terminology data. Your version of the AWS SDK performs a Base64-encoding on this field before sending a request to the AWS service. Users of the SDK should not perform Base64-encoding themselves.

    • format

      public final TerminologyDataFormat format()

      The data format of the custom terminology.

      If the service returns an enum value that is not available in the current SDK version, format will return TerminologyDataFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

      Returns:
      The data format of the custom terminology.
      See Also:

    • formatAsString

      public final String formatAsString()

      The data format of the custom terminology.

      If the service returns an enum value that is not available in the current SDK version, format will return TerminologyDataFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

      Returns:
      The data format of the custom terminology.
      See Also:

    • directionality

      public final Directionality directionality()

      The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).

      UNI

      The terminology resource has one source language (for example, the first column in a CSV file), and all of its other languages are target languages.

      MULTI

      Any language in the terminology resource can be the source language or a target language. A single multi-directional terminology resource can be used for jobs that translate different language pairs. For example, if the terminology contains English and Spanish terms, it can be used for jobs that translate English to Spanish and Spanish to English.

      When you create a custom terminology resource without specifying the directionality, it behaves as uni-directional terminology, although this parameter will have a null value.

      If the service returns an enum value that is not available in the current SDK version, directionality will return Directionality.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directionalityAsString().

      Returns:
      The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).

      UNI

      The terminology resource has one source language (for example, the first column in a CSV file), and all of its other languages are target languages.

      MULTI

      Any language in the terminology resource can be the source language or a target language. A single multi-directional terminology resource can be used for jobs that translate different language pairs. For example, if the terminology contains English and Spanish terms, it can be used for jobs that translate English to Spanish and Spanish to English.

      When you create a custom terminology resource without specifying the directionality, it behaves as uni-directional terminology, although this parameter will have a null value.

      See Also:

    • directionalityAsString

      public final String directionalityAsString()

      The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).

      UNI

      The terminology resource has one source language (for example, the first column in a CSV file), and all of its other languages are target languages.

      MULTI

      Any language in the terminology resource can be the source language or a target language. A single multi-directional terminology resource can be used for jobs that translate different language pairs. For example, if the terminology contains English and Spanish terms, it can be used for jobs that translate English to Spanish and Spanish to English.

      When you create a custom terminology resource without specifying the directionality, it behaves as uni-directional terminology, although this parameter will have a null value.

      If the service returns an enum value that is not available in the current SDK version, directionality will return Directionality.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directionalityAsString().

      Returns:
      The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).

      UNI

      The terminology resource has one source language (for example, the first column in a CSV file), and all of its other languages are target languages.

      MULTI

      Any language in the terminology resource can be the source language or a target language. A single multi-directional terminology resource can be used for jobs that translate different language pairs. For example, if the terminology contains English and Spanish terms, it can be used for jobs that translate English to Spanish and Spanish to English.

      When you create a custom terminology resource without specifying the directionality, it behaves as uni-directional terminology, although this parameter will have a null value.

      See Also:

    • toBuilder

      public TerminologyData.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<TerminologyData.Builder,TerminologyData>
      Returns:
      a builder for type T

    • builder

      public static TerminologyData.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TerminologyData.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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