software.amazon.awssdk.services.transcribe.model

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(value="software.amazon.awssdk:codegen")
public final class ListVocabulariesRequest
extends TranscribeRequest
implements ToCopyableBuilder<ListVocabulariesRequest.Builder,ListVocabulariesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListVocabulariesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListVocabulariesRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() The maximum number of vocabularies to return in the response.
String	nameContains() When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string.
String	nextToken() If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.
List<SdkField<?>>	sdkFields()
static Class<? extends ListVocabulariesRequest.Builder>	serializableBuilderClass()
VocabularyState	stateEquals() When specified, only returns vocabularies with the VocabularyState field equal to the specified state.
String	stateEqualsAsString() When specified, only returns vocabularies with the VocabularyState field equal to the specified state.
ListVocabulariesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

nextToken

public String nextToken()

If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.

Returns:

If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.

maxResults

public Integer maxResults()

The maximum number of vocabularies to return in the response. If there are fewer results in the list, this response contains only the actual results.

Returns:

The maximum number of vocabularies to return in the response. If there are fewer results in the list, this response contains only the actual results.

stateEquals

public VocabularyState stateEquals()

When specified, only returns vocabularies with the VocabularyState field equal to the specified state.

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:

When specified, only returns vocabularies with the VocabularyState field equal to the specified state.

See Also:

VocabularyState

stateEqualsAsString

public String stateEqualsAsString()

When specified, only returns vocabularies with the VocabularyState field equal to the specified state.

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:

When specified, only returns vocabularies with the VocabularyState field equal to the specified state.

See Also:

VocabularyState

nameContains

public String nameContains()

When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is case-insensitive, ListVocabularies will return both "vocabularyname" and "VocabularyName" in the response list.

Returns:

When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is case-insensitive, ListVocabularies will return both "vocabularyname" and "VocabularyName" in the response list.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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