com.amazonaws.services.polly.model

Class DescribeVoicesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.polly.model.DescribeVoicesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeVoicesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeVoicesRequest()

Method Summary

Modifier and Type	Method and Description
DescribeVoicesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getEngine() Specifies the engine (standard, neural or long-form) used by Amazon Polly when processing input text for speech synthesis.
Boolean	getIncludeAdditionalLanguageCodes() Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language.
String	getLanguageCode() The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned.
String	getNextToken() An opaque pagination token returned from the previous DescribeVoices operation.
int	hashCode()
Boolean	isIncludeAdditionalLanguageCodes() Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language.
void	setEngine(Engine engine) Specifies the engine (standard, neural or long-form) used by Amazon Polly when processing input text for speech synthesis.
void	setEngine(String engine) Specifies the engine (standard, neural or long-form) used by Amazon Polly when processing input text for speech synthesis.
void	setIncludeAdditionalLanguageCodes(Boolean includeAdditionalLanguageCodes) Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language.
void	setLanguageCode(LanguageCode languageCode) The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned.
void	setLanguageCode(String languageCode) The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned.
void	setNextToken(String nextToken) An opaque pagination token returned from the previous DescribeVoices operation.
String	toString() Returns a string representation of this object.
DescribeVoicesRequest	withEngine(Engine engine) Specifies the engine (standard, neural or long-form) used by Amazon Polly when processing input text for speech synthesis.
DescribeVoicesRequest	withEngine(String engine) Specifies the engine (standard, neural or long-form) used by Amazon Polly when processing input text for speech synthesis.
DescribeVoicesRequest	withIncludeAdditionalLanguageCodes(Boolean includeAdditionalLanguageCodes) Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language.
DescribeVoicesRequest	withLanguageCode(LanguageCode languageCode) The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned.
DescribeVoicesRequest	withLanguageCode(String languageCode) The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned.
DescribeVoicesRequest	withNextToken(String nextToken) An opaque pagination token returned from the previous DescribeVoices operation.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeVoicesRequest

public DescribeVoicesRequest()

Method Detail

setEngine

public void setEngine(String engine)

Specifies the engine (standard, neural or long-form) used by Amazon Polly when processing input text for speech synthesis.

Parameters:

engine - Specifies the engine (standard, neural or long-form) used by Amazon Polly when processing input text for speech synthesis.

See Also:

Engine

getEngine

public String getEngine()

Specifies the engine (standard, neural or long-form) used by Amazon Polly when processing input text for speech synthesis.

Returns:

Specifies the engine (standard, neural or long-form) used by Amazon Polly when processing input text for speech synthesis.

See Also:

Engine

withEngine

public DescribeVoicesRequest withEngine(String engine)

Specifies the engine (standard, neural or long-form) used by Amazon Polly when processing input text for speech synthesis.

Parameters:

engine - Specifies the engine (standard, neural or long-form) used by Amazon Polly when processing input text for speech synthesis.

Returns:

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

See Also:

Engine

setEngine

public void setEngine(Engine engine)

Specifies the engine (standard, neural or long-form) used by Amazon Polly when processing input text for speech synthesis.

Parameters:

engine - Specifies the engine (standard, neural or long-form) used by Amazon Polly when processing input text for speech synthesis.

See Also:

Engine

withEngine

public DescribeVoicesRequest withEngine(Engine engine)

Specifies the engine (standard, neural or long-form) used by Amazon Polly when processing input text for speech synthesis.

Parameters:

engine - Specifies the engine (standard, neural or long-form) used by Amazon Polly when processing input text for speech synthesis.

Returns:

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

See Also:

Engine

setLanguageCode

public void setLanguageCode(String languageCode)

The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

Parameters:

languageCode - The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

See Also:

LanguageCode

getLanguageCode

public String getLanguageCode()

The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

Returns:

The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

See Also:

LanguageCode

withLanguageCode

public DescribeVoicesRequest withLanguageCode(String languageCode)

The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

Parameters:

languageCode - The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

Returns:

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

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(LanguageCode languageCode)

The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

Parameters:

languageCode - The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

See Also:

LanguageCode

withLanguageCode

public DescribeVoicesRequest withLanguageCode(LanguageCode languageCode)

The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

Parameters:

languageCode - The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

Returns:

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

See Also:

LanguageCode

setIncludeAdditionalLanguageCodes

public void setIncludeAdditionalLanguageCodes(Boolean includeAdditionalLanguageCodes)

Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but not if you specify no.

Parameters:

includeAdditionalLanguageCodes - Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but not if you specify no.

getIncludeAdditionalLanguageCodes

public Boolean getIncludeAdditionalLanguageCodes()

Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but not if you specify no.

Returns:

Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but not if you specify no.

withIncludeAdditionalLanguageCodes

public DescribeVoicesRequest withIncludeAdditionalLanguageCodes(Boolean includeAdditionalLanguageCodes)

Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but not if you specify no.

Parameters:

includeAdditionalLanguageCodes - Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but not if you specify no.

Returns:

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

isIncludeAdditionalLanguageCodes

public Boolean isIncludeAdditionalLanguageCodes()

Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but not if you specify no.

Returns:

Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but not if you specify no.

setNextToken

public void setNextToken(String nextToken)

An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.

Parameters:

nextToken - An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.

getNextToken

public String getNextToken()

An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.

Returns:

An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.

withNextToken

public DescribeVoicesRequest withNextToken(String nextToken)

An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.

Parameters:

nextToken - An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeVoicesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()