software.amazon.awssdk.services.pinpoint.model

Class VoiceTemplateResponse

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.VoiceTemplateResponse

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class VoiceTemplateResponse
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VoiceTemplateResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the message template.
String	body() The text of the script that's used in messages that are based on the message template, in plain text format.
static VoiceTemplateResponse.Builder	builder()
String	creationDate() The date, in ISO 8601 format, when the message template was created.
String	defaultSubstitutions() The JSON object that specifies the default values that are used 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 that's used when synthesizing the text of the script in messages that are based on the message template.
String	lastModifiedDate() The date, in ISO 8601 format, when the message template was last modified.
List<SdkField<?>>	sdkFields()
static Class<? extends VoiceTemplateResponse.Builder>	serializableBuilderClass()
Map<String,String>	tags() A string-to-string map of key-value pairs that identifies the tags that are associated with the message template.
String	templateDescription() The custom description of the message template.
String	templateName() The name of the message template.
TemplateType	templateType() The type of channel that the message template is designed for.
String	templateTypeAsString() The type of channel that the message template is designed for.
VoiceTemplateResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
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.
String	voiceId() The name of the voice that's used 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

arn

public final String arn()

The Amazon Resource Name (ARN) of the message template.

Returns:

The Amazon Resource Name (ARN) of the message template.

body

public final String 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

public final String 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

public final String 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

public final String 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

public final String 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 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()

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

public final String templateDescription()

The custom description of the message template.

Returns:

The custom description of the message template.

templateName

public final String templateName()

The name of the message template.

Returns:

The name of the message template.

templateType

public final TemplateType 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 return TemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from templateTypeAsString().

Returns:

The type of channel that the message template is designed for. For a voice template, this value is VOICE.

See Also:

TemplateType

templateTypeAsString

public final String 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 return TemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from templateTypeAsString().

Returns:

The type of channel that the message template is designed for. For a voice template, this value is VOICE.

See Also:

TemplateType

version

public 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.

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

public final String 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

public VoiceTemplateResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VoiceTemplateResponse.Builder,VoiceTemplateResponse>

builder

public static VoiceTemplateResponse.Builder builder()

serializableBuilderClass

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