Class LexiconAttributes

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

Contains metadata describing the lexicon such as the number of lexemes, language code, and so on. For more information, see Managing Lexicons.

See Also:

  • Method Details

    • alphabet

      public final String alphabet()

      Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa.

      Returns:
      Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa.

    • languageCode

      public final LanguageCode languageCode()

      Language code that the lexicon applies to. A lexicon with a language code such as "en" would be applied to all English languages (en-GB, en-US, en-AUS, en-WLS, and so on.

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

      Returns:
      Language code that the lexicon applies to. A lexicon with a language code such as "en" would be applied to all English languages (en-GB, en-US, en-AUS, en-WLS, and so on.
      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      Language code that the lexicon applies to. A lexicon with a language code such as "en" would be applied to all English languages (en-GB, en-US, en-AUS, en-WLS, and so on.

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

      Returns:
      Language code that the lexicon applies to. A lexicon with a language code such as "en" would be applied to all English languages (en-GB, en-US, en-AUS, en-WLS, and so on.
      See Also:

    • lastModified

      public final Instant lastModified()

      Date lexicon was last modified (a timestamp value).

      Returns:
      Date lexicon was last modified (a timestamp value).

    • lexiconArn

      public final String lexiconArn()

      Amazon Resource Name (ARN) of the lexicon.

      Returns:
      Amazon Resource Name (ARN) of the lexicon.

    • lexemesCount

      public final Integer lexemesCount()

      Number of lexemes in the lexicon.

      Returns:
      Number of lexemes in the lexicon.

    • size

      public final Integer size()

      Total size of the lexicon, in characters.

      Returns:
      Total size of the lexicon, in characters.

    • toBuilder

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

    • builder

      public static LexiconAttributes.Builder builder()

    • serializableBuilderClass

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