Class GetVocabularyResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.transcribe.model.TranscribeResponse
software.amazon.awssdk.services.transcribe.model.GetVocabularyResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetVocabularyResponse.Builder,GetVocabularyResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetVocabularyResponse extends TranscribeResponse implements ToCopyableBuilder<GetVocabularyResponse.Builder,GetVocabularyResponse>

  • Method Details

    • vocabularyName

      public final String vocabularyName()

      The name of the custom vocabulary you requested information about.

      Returns:
      The name of the custom vocabulary you requested information about.

    • languageCode

      public final LanguageCode languageCode()

      The language code you selected for your custom vocabulary.

      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 you selected for your custom vocabulary.
      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      The language code you selected for your custom vocabulary.

      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 you selected for your custom vocabulary.
      See Also:

    • 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:

    • 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.

    • failureReason

      public final String failureReason()

      If VocabularyState is FAILED, FailureReason contains information about why the custom vocabulary request failed. See also: Common Errors.

      Returns:
      If VocabularyState is FAILED, FailureReason contains information about why the custom vocabulary request failed. See also: Common Errors.

    • downloadUri

      public final String downloadUri()

      The Amazon S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.

      Returns:
      The Amazon S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.

    • toBuilder

      public GetVocabularyResponse.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<GetVocabularyResponse.Builder,GetVocabularyResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetVocabularyResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetVocabularyResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.