Class VoiceMessage
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<VoiceMessage.Builder,
VoiceMessage>
Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
body()
The text of the script to use for the voice message.static VoiceMessage.Builder
builder()
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()
final boolean
For responses, this returns true if the service returned a value for the Substitutions property.final String
The code for the language to use when synthesizing the text of the message script.final String
The long code to send the voice message from.static Class
<? extends VoiceMessage.Builder> The default message variables to use in the voice message.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 name of the voice to use when delivering the message.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
body
The text of the script to use for the voice message.
- Returns:
- The text of the script to use for the voice message.
-
languageCode
The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
- Returns:
- The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
-
originationNumber
The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.
- Returns:
- The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.
-
hasSubstitutions
public final boolean hasSubstitutions()For responses, this returns true if the service returned a value for the Substitutions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
substitutions
The default message variables to use in the voice message. You can override the default variables with individual address variables.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSubstitutions()
method.- Returns:
- The default message variables to use in the voice message. You can override the default variables with individual address variables.
-
voiceId
The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
- Returns:
- The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
-
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<VoiceMessage.Builder,
VoiceMessage> - 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
-