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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeVoicesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeVoicesRequest.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()
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() 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

languageCode

public 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 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 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 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()

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<DescribeVoicesRequest.Builder,DescribeVoicesRequest>

Specified by:

toBuilder in class PollyRequest

Returns:

a builder for type T

builder

public static DescribeVoicesRequest.Builder builder()

serializableBuilderClass

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