Class TranslationName

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

A translation or alternative name for an address component.

See Also:

  • Method Details

    • value

      public final String value()

      The translated or alternative name value.

      Returns:
      The translated or alternative name value.

    • language

      public final String language()

      A BCP 47 compliant language code for the translation name.

      Returns:
      A BCP 47 compliant language code for the translation name.

    • type

      public final TranslationNameType type()

      The type of translation name. Valid values are Abbreviation, AreaCode, BaseName, Exonym, Shortened, and Synonym.

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

      Returns:
      The type of translation name. Valid values are Abbreviation, AreaCode, BaseName, Exonym, Shortened, and Synonym.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of translation name. Valid values are Abbreviation, AreaCode, BaseName, Exonym, Shortened, and Synonym.

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

      Returns:
      The type of translation name. Valid values are Abbreviation, AreaCode, BaseName, Exonym, Shortened, and Synonym.
      See Also:

    • primary

      public final Boolean primary()

      If true, indicates this is the primary name variant for the given language.

      Returns:
      If true, indicates this is the primary name variant for the given language.

    • transliterated

      public final Boolean transliterated()

      If true, indicates this name is a transliterated version rather than a native script translation.

      Returns:
      If true, indicates this name is a transliterated version rather than a native script translation.

    • toBuilder

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

    • builder

      public static TranslationName.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TranslationName.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.