Class ListVocabulariesRequest

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

  • Method Details

    • nextToken

      public final String nextToken()

      If your ListVocabularies request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

      Returns:
      If your ListVocabularies request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

    • maxResults

      public final Integer maxResults()

      The maximum number of custom vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.

      Returns:
      The maximum number of custom vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.

    • stateEquals

      public final VocabularyState stateEquals()

      Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you do not include StateEquals, all custom medical vocabularies are returned.

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

      Returns:
      Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you do not include StateEquals, all custom medical vocabularies are returned.
      See Also:

    • stateEqualsAsString

      public final String stateEqualsAsString()

      Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you do not include StateEquals, all custom medical vocabularies are returned.

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

      Returns:
      Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you do not include StateEquals, all custom medical vocabularies are returned.
      See Also:

    • nameContains

      public final String nameContains()

      Returns only the custom vocabularies that contain the specified string. The search is not case sensitive.

      Returns:
      Returns only the custom vocabularies that contain the specified string. The search is not case sensitive.

    • toBuilder

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

    • builder

      public static ListVocabulariesRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.