Package software.amazon.awssdk.services.polly.model

Class DescribeVoicesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.polly.model.PollyRequest

software.amazon.awssdk.services.polly.model.DescribeVoicesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeVoicesRequest.Builder,DescribeVoicesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeVoicesRequest
extends PollyRequest
implements ToCopyableBuilder<DescribeVoicesRequest.Builder,DescribeVoicesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeVoicesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeVoicesRequest.Builder	builder()
Engine	engine()	Specifies the engine (standard, neural, long-form or generative) used by Amazon Polly when processing input text for speech synthesis.
String	engineAsString()	Specifies the engine (standard, neural, long-form or generative) used by Amazon Polly when processing input text for speech synthesis.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	includeAdditionalLanguageCodes()	Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language.
LanguageCode	languageCode()	The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned.
String	languageCodeAsString()	The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned.
String	nextToken()	An opaque pagination token returned from the previous DescribeVoices operation.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeVoicesRequest.Builder>	serializableBuilderClass()
DescribeVoicesRequest.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

engine

public final Engine engine()

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

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

Returns:

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

See Also:

Engine

engineAsString

public final String engineAsString()

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

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

Returns:

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

See Also:

Engine

languageCode

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

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

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

languageCodeAsString

public final String languageCodeAsString()

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.

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

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

includeAdditionalLanguageCodes

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

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.

nextToken

public final String nextToken()

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.

toBuilder

public DescribeVoicesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeVoicesRequest.Builder,DescribeVoicesRequest>

Specified by:

toBuilder in class PollyRequest

builder

public static DescribeVoicesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeVoicesRequest.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