Class VoiceSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<VoiceSettings.Builder,
VoiceSettings>
Defines settings for using an Amazon Polly voice to communicate with a user.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic VoiceSettings.Builder
builder()
final VoiceEngine
engine()
Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user.final String
Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends VoiceSettings.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
voiceId()
The identifier of the Amazon Polly voice to use.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
voiceId
The identifier of the Amazon Polly voice to use.
- Returns:
- The identifier of the Amazon Polly voice to use.
-
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 theSynthesizeSpeech
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 returnVoiceEngine.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromengineAsString()
.- 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 theSynthesizeSpeech
operation in the Amazon Polly developer guide.If you do not specify a value, the default is
standard
. - See Also:
-
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 theSynthesizeSpeech
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 returnVoiceEngine.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromengineAsString()
.- 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 theSynthesizeSpeech
operation in the Amazon Polly developer guide.If you do not specify a value, the default is
standard
. - See Also:
-
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 interfaceToCopyableBuilder<VoiceSettings.Builder,
VoiceSettings> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-