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

Class ListVocabulariesResponse

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.ListVocabulariesResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListVocabulariesResponse.Builder,ListVocabulariesResponse>
@Generated("software.amazon.awssdk:codegen") public final class ListVocabulariesResponse extends TranscribeResponse implements ToCopyableBuilder<ListVocabulariesResponse.Builder,ListVocabulariesResponse>

  • Method Details

    • status

      public final VocabularyState status()

      Lists all custom vocabularies that have the status specified in your request. Vocabularies are ordered by creation date, with the newest vocabulary first.

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

      Returns:
      Lists all custom vocabularies that have the status specified in your request. Vocabularies are ordered by creation date, with the newest vocabulary first.
      See Also:

    • statusAsString

      public final String statusAsString()

      Lists all custom vocabularies that have the status specified in your request. Vocabularies are ordered by creation date, with the newest vocabulary first.

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

      Returns:
      Lists all custom vocabularies that have the status specified in your request. Vocabularies are ordered by creation date, with the newest vocabulary first.
      See Also:

    • nextToken

      public final String nextToken()

      If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

      Returns:
      If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

    • hasVocabularies

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

    • vocabularies

      public final List<VocabularyInfo> vocabularies()

      Provides information about the custom vocabularies that match the criteria specified in your request.

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

      Returns:
      Provides information about the custom vocabularies that match the criteria specified in your request.

    • toBuilder

      public ListVocabulariesResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListVocabulariesResponse.Builder,ListVocabulariesResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static ListVocabulariesResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListVocabulariesResponse.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkResponse

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo