software.amazon.awssdk.services.polly.model

Class Voice

java.lang.Object

software.amazon.awssdk.services.polly.model.Voice

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Voice.Builder,Voice>

@Generated(value="software.amazon.awssdk:codegen")
public final class Voice
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Voice.Builder,Voice>

Description of the voice.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Voice.Builder

Method Summary

Modifier and Type	Method and Description
List<LanguageCode>	additionalLanguageCodes() Additional codes for languages available for the specified voice in addition to its default language.
List<String>	additionalLanguageCodesAsStrings() Additional codes for languages available for the specified voice in addition to its default language.
static Voice.Builder	builder()
boolean	equals(Object obj)
Gender	gender() Gender of the voice.
String	genderAsString() Gender of the voice.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
VoiceId	id() Amazon Polly assigned voice ID.
String	idAsString() Amazon Polly assigned voice ID.
LanguageCode	languageCode() Language code of the voice.
String	languageCodeAsString() Language code of the voice.
String	languageName() Human readable name of the language in English.
String	name() Name of the voice (for example, Salli, Kendra, etc.).
List<SdkField<?>>	sdkFields()
static Class<? extends Voice.Builder>	serializableBuilderClass()
Voice.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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

gender

public Gender gender()

Gender of the voice.

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

Returns:

Gender of the voice.

See Also:

Gender

genderAsString

public String genderAsString()

Gender of the voice.

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

Returns:

Gender of the voice.

See Also:

Gender

id

public VoiceId id()

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

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

Returns:

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

See Also:

VoiceId

idAsString

public String idAsString()

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

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

Returns:

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

See Also:

VoiceId

languageCode

public LanguageCode languageCode()

Language code of the voice.

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:

Language code of the voice.

See Also:

LanguageCode

languageCodeAsString

public String languageCodeAsString()

Language code of the voice.

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:

Language code of the voice.

See Also:

LanguageCode

languageName

public String languageName()

Human readable name of the language in English.

Returns:

Human readable name of the language in English.

name

public String name()

Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

Returns:

Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

additionalLanguageCodes

public List<LanguageCode> additionalLanguageCodes()

Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

additionalLanguageCodesAsStrings

public List<String> additionalLanguageCodesAsStrings()

Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

toBuilder

public Voice.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<Voice.Builder,Voice>

Returns:

a builder for type T

builder

public static Voice.Builder builder()

serializableBuilderClass

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

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.