Package software.amazon.awssdk.services.lexmodelsv2.model

Class VoiceSettings

java.lang.Object

software.amazon.awssdk.services.lexmodelsv2.model.VoiceSettings

All Implemented Interfaces:

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

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

Defines settings for using an Amazon Polly voice to communicate with a user.

Valid values include:

• standard

• neural

• long-form

• generative

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VoiceSettings.Builder

Method Summary

Modifier and Type	Method	Description
static VoiceSettings.Builder	builder()
VoiceEngine	engine()	Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user.
String	engineAsString()	Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends VoiceSettings.Builder>	serializableBuilderClass()
VoiceSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	voiceId()	The identifier of the Amazon Polly voice to use.

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

voiceId

public final String voiceId()

The identifier of the Amazon Polly voice to use.

Returns:

The identifier of the Amazon Polly voice to use.

engine

public final VoiceEngine engine()

Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.

If you do not specify a value, the default is standard.

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

Returns:

Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.

If you do not specify a value, the default is standard.

See Also:

VoiceEngine

engineAsString

public final String engineAsString()

Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.

If you do not specify a value, the default is standard.

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

Returns:

Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.

If you do not specify a value, the default is standard.

See Also:

VoiceEngine

toBuilder

public VoiceSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VoiceSettings.Builder,VoiceSettings>

builder

public static VoiceSettings.Builder builder()

serializableBuilderClass

public static Class<? extends VoiceSettings.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo