Class VoiceTemplateResponse
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<VoiceTemplateResponse.Builder,
VoiceTemplateResponse>
Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the message template.final String
body()
The text of the script that's used in messages that are based on the message template, in plain text format.builder()
final String
The date, in ISO 8601 format, when the message template was created.final String
The JSON object that specifies the default values that are used for message variables in the message template.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
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The code for the language that's used when synthesizing the text of the script in messages that are based on the message template.final String
The date, in ISO 8601 format, when the message template was last modified.static Class
<? extends VoiceTemplateResponse.Builder> tags()
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template.final String
The custom description of the message template.final String
The name of the message template.final TemplateType
The type of channel that the message template is designed for.final String
The type of channel that the message template is designed for.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
version()
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.final String
voiceId()
The name of the voice that's used when delivering messages that are based on the message template.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the message template.
- Returns:
- The Amazon Resource Name (ARN) of the message template.
-
body
The text of the script that's used in messages that are based on the message template, in plain text format.
- Returns:
- The text of the script that's used in messages that are based on the message template, in plain text format.
-
creationDate
The date, in ISO 8601 format, when the message template was created.
- Returns:
- The date, in ISO 8601 format, when the message template was created.
-
defaultSubstitutions
The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
- Returns:
- The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
-
languageCode
The code for the language that's used when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
- Returns:
- The code for the language that's used when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
-
lastModifiedDate
The date, in ISO 8601 format, when the message template was last modified.
- Returns:
- The date, in ISO 8601 format, when the message template was last modified.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags 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. -
tags
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
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
hasTags()
method.- Returns:
- A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
-
templateDescription
The custom description of the message template.
- Returns:
- The custom description of the message template.
-
templateName
The name of the message template.
- Returns:
- The name of the message template.
-
templateType
The type of channel that the message template is designed for. For a voice template, this value is VOICE.
If the service returns an enum value that is not available in the current SDK version,
templateType
will returnTemplateType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtemplateTypeAsString()
.- Returns:
- The type of channel that the message template is designed for. For a voice template, this value is VOICE.
- See Also:
-
templateTypeAsString
The type of channel that the message template is designed for. For a voice template, this value is VOICE.
If the service returns an enum value that is not available in the current SDK version,
templateType
will returnTemplateType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtemplateTypeAsString()
.- Returns:
- The type of channel that the message template is designed for. For a voice template, this value is VOICE.
- See Also:
-
version
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
- Returns:
- The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
-
voiceId
The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.
- Returns:
- The name of the voice that's used when delivering messages that are based on the message template. 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<VoiceTemplateResponse.Builder,
VoiceTemplateResponse> - 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
-