software.amazon.awssdk.services.pinpoint.model

Class VoiceTemplateRequest

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.VoiceTemplateRequest

All Implemented Interfaces:

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

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

Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VoiceTemplateRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	body() The text of the script to use in messages that are based on the message template, in plain text format.
static VoiceTemplateRequest.Builder	builder()
String	defaultSubstitutions() A JSON object that specifies the default values to use for message variables in the message template.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	languageCode() The code for the language to use when synthesizing the text of the script in messages that are based on the message template.
List<SdkField<?>>	sdkFields()
static Class<? extends VoiceTemplateRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()
String	templateDescription() A custom description of the message template.
VoiceTemplateRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	voiceId() The name of the voice to use when delivering messages that are based on the message template.

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

body

public final String body()

The text of the script to use in messages that are based on the message template, in plain text format.

Returns:

The text of the script to use in messages that are based on the message template, in plain text format.

defaultSubstitutions

public final String defaultSubstitutions()

A JSON object that specifies the default values to use 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. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

Returns:

A JSON object that specifies the default values to use 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. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

languageCode

public final String languageCode()

The code for the language to use 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 to use 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.

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 the isEmpty() 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

public final Map<String,String> tags()

As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate 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:

As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

templateDescription

public final String templateDescription()

A custom description of the message template.

Returns:

A custom description of the message template.

voiceId

public final String voiceId()

The name of the voice to use 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 to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

toBuilder

public VoiceTemplateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VoiceTemplateRequest.Builder,VoiceTemplateRequest>

builder

public static VoiceTemplateRequest.Builder builder()

serializableBuilderClass

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