Class Vocabulary

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

Contains information about a custom vocabulary.

See Also:

  • Method Details

    • name

      public final String name()

      A unique name of the custom vocabulary.

      Returns:
      A unique name of the custom vocabulary.

    • id

      public final String id()

      The identifier of the custom vocabulary.

      Returns:
      The identifier of the custom vocabulary.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the custom vocabulary.

      Returns:
      The Amazon Resource Name (ARN) of the custom vocabulary.

    • languageCode

      public final VocabularyLanguageCode languageCode()

      The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

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

      Returns:
      The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

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

      Returns:
      The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
      See Also:

    • state

      public final VocabularyState state()

      The current state of the custom vocabulary.

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

      Returns:
      The current state of the custom vocabulary.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the custom vocabulary.

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

      Returns:
      The current state of the custom vocabulary.
      See Also:

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The timestamp when the custom vocabulary was last modified.

      Returns:
      The timestamp when the custom vocabulary was last modified.

    • failureReason

      public final String failureReason()

      The reason why the custom vocabulary was not created.

      Returns:
      The reason why the custom vocabulary was not created.

    • content

      public final String content()

      The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.

      Returns:
      The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final Map<String,String> tags()

      The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

      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 hasTags() method.

      Returns:
      The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

    • toBuilder

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

    • builder

      public static Vocabulary.Builder builder()

    • serializableBuilderClass

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