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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults() The maximum number of vocabularies to return in each page of results.
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()
String	toString() Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

nextToken

public final 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 final Integer maxResults()

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

Returns:

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

stateEquals

public final 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 final 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 final String nameContains()

When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is not case sensitive, ListVocabularies returns 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 not case sensitive, ListVocabularies returns both "vocabularyname" and "VocabularyName" in the response list.

toBuilder

public ListVocabulariesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListVocabulariesRequest.Builder,ListVocabulariesRequest>

Specified by:

toBuilder in class TranscribeRequest

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)

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 SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo