VoiceTemplateRequest (AWS Java SDK :: Services :: Amazon Pinpoint 2.10.41 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`VoiceTemplateRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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()` A string-to-string map of key-value pairs that defines the tags to associate with the message template.
`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 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 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 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 boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public Map<String,String> tags()
```
    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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - templateDescription
```
public String templateDescription()
```
    A custom description of the message template.
    
    Returns:
    
    A custom description of the message template.
  - voiceId
```
public 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class VoiceTemplateRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

body

defaultSubstitutions

languageCode

hasTags

tags

templateDescription

voiceId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields