Class VocabularyInfo

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

Provides information about a custom vocabulary, including the language of the custom vocabulary, when it was last modified, its name, and the processing state.

See Also:

  • Method Details

    • vocabularyName

      public final String vocabularyName()

      A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

      Returns:
      A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

    • languageCode

      public final LanguageCode languageCode()

      The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only one language.

      A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio.

      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:
      The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only one language.

      A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio.

      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only one language.

      A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio.

      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:
      The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only one language.

      A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio.

      See Also:

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The date and time the specified custom vocabulary was last modified.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

      Returns:
      The date and time the specified custom vocabulary was last modified.

      Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

    • vocabularyState

      public final VocabularyState vocabularyState()

      The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.

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

      Returns:
      The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.
      See Also:

    • vocabularyStateAsString

      public final String vocabularyStateAsString()

      The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.

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

      Returns:
      The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.
      See Also:

    • toBuilder

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

    • builder

      public static VocabularyInfo.Builder builder()

    • serializableBuilderClass

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