Package software.amazon.awssdk.services.transcribe.model

Class VocabularyFilterInfo

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

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

See Also:

  • Method Details

    • vocabularyFilterName

      public final String vocabularyFilterName()

      A unique name, chosen by you, for your custom vocabulary filter. 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 filter. 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 that represents the language of the entries in your vocabulary filter. Each custom vocabulary filter must contain terms in only one language.

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

      For a list of supported languages and their associated language codes, refer to the Supported languages table.

      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 that represents the language of the entries in your vocabulary filter. Each custom vocabulary filter must contain terms in only one language.

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

      For a list of supported languages and their associated language codes, refer to the Supported languages table.

      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      The language code that represents the language of the entries in your vocabulary filter. Each custom vocabulary filter must contain terms in only one language.

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

      For a list of supported languages and their associated language codes, refer to the Supported languages table.

      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 that represents the language of the entries in your vocabulary filter. Each custom vocabulary filter must contain terms in only one language.

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

      For a list of supported languages and their associated language codes, refer to the Supported languages table.

      See Also:

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The date and time the specified custom vocabulary filter 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 filter 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.

    • toBuilder

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

    • builder

      public static VocabularyFilterInfo.Builder builder()

    • serializableBuilderClass

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