com.amazonaws.services.transcribe.model

Class ListVocabulariesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.transcribe.model.ListVocabulariesRequest

All Implemented Interfaces:

Serializable, Cloneable

public class ListVocabulariesRequest
extends AmazonWebServiceRequest
implements Serializable

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListVocabulariesRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Integer	getMaxResults() The maximum number of vocabularies to return in the response.
String	getNameContains() When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string.
String	getNextToken() If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.
String	getStateEquals() When specified, only returns vocabularies with the VocabularyState field equal to the specified state.
int	hashCode()
void	setMaxResults(Integer maxResults) The maximum number of vocabularies to return in the response.
void	setNameContains(String nameContains) When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string.
void	setNextToken(String nextToken) If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.
void	setStateEquals(String stateEquals) When specified, only returns vocabularies with the VocabularyState field equal to the specified state.
void	setStateEquals(VocabularyState stateEquals) When specified, only returns vocabularies with the VocabularyState field equal to the specified state.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListVocabulariesRequest	withMaxResults(Integer maxResults) The maximum number of vocabularies to return in the response.
ListVocabulariesRequest	withNameContains(String nameContains) When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string.
ListVocabulariesRequest	withNextToken(String nextToken) If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.
ListVocabulariesRequest	withStateEquals(String stateEquals) When specified, only returns vocabularies with the VocabularyState field equal to the specified state.
ListVocabulariesRequest	withStateEquals(VocabularyState stateEquals) When specified, only returns vocabularies with the VocabularyState field equal to the specified state.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

ListVocabulariesRequest

public ListVocabulariesRequest()

Method Detail

getNextToken

public String getNextToken()

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

Constraints:
Length: - 8192

Returns:

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

setNextToken

public void setNextToken(String nextToken)

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

Constraints:
Length: - 8192

Parameters:

nextToken -

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

withNextToken

public ListVocabulariesRequest withNextToken(String nextToken)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: - 8192

Parameters:

nextToken -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public Integer getMaxResults()

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.

Constraints:
Range: 1 - 100

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.

setMaxResults

public void setMaxResults(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.

Constraints:
Range: 1 - 100

Parameters:

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.

withMaxResults

public ListVocabulariesRequest withMaxResults(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 a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 100

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getStateEquals

public String getStateEquals()

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

Constraints:
Allowed Values: PENDING, READY, FAILED

Returns:

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

See Also:

VocabularyState

setStateEquals

public void setStateEquals(String stateEquals)

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

Constraints:
Allowed Values: PENDING, READY, FAILED

Parameters:

stateEquals -

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

See Also:

VocabularyState

withStateEquals

public ListVocabulariesRequest withStateEquals(String stateEquals)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: PENDING, READY, FAILED

Parameters:

stateEquals -

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

VocabularyState

setStateEquals

public void setStateEquals(VocabularyState stateEquals)

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

Constraints:
Allowed Values: PENDING, READY, FAILED

Parameters:

stateEquals -

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

See Also:

VocabularyState

withStateEquals

public ListVocabulariesRequest withStateEquals(VocabularyState stateEquals)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: PENDING, READY, FAILED

Parameters:

stateEquals -

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

VocabularyState

getNameContains

public String getNameContains()

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.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

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.

setNameContains

public void setNameContains(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.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Parameters:

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.

withNameContains

public ListVocabulariesRequest withNameContains(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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object