VoiceTemplateRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pinpoint.model.VoiceTemplateRequest

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class VoiceTemplateRequest
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

VoiceTemplateRequest()

Constructors
Constructor and Description
`VoiceTemplateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VoiceTemplateRequest`	`addTagsEntry(String key, String value)` Add a single Tags entry
`VoiceTemplateRequest`	`clearTagsEntries()` Removes all the entries added into Tags.
`VoiceTemplateRequest`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBody()` The text of the script to use in messages that are based on the message template, in plain text format.
`String`	`getDefaultSubstitutions()` A JSON object that specifies the default values to use for message variables in the message template.
`String`	`getLanguageCode()` The code for the language to use when synthesizing the text of the script in messages that are based on the message template.
`Map<String,String>`	`getTags()`
`String`	`getTemplateDescription()` A custom description of the message template.
`String`	`getVoiceId()` The name of the voice to use when delivering messages that are based on the message template.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBody(String body)` The text of the script to use in messages that are based on the message template, in plain text format.
`void`	`setDefaultSubstitutions(String defaultSubstitutions)` A JSON object that specifies the default values to use for message variables in the message template.
`void`	`setLanguageCode(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.
`void`	`setTags(Map<String,String> tags)`
`void`	`setTemplateDescription(String templateDescription)` A custom description of the message template.
`void`	`setVoiceId(String voiceId)` The name of the voice to use when delivering messages that are based on the message template.
`String`	`toString()` Returns a string representation of this object.
`VoiceTemplateRequest`	`withBody(String body)` The text of the script to use in messages that are based on the message template, in plain text format.
`VoiceTemplateRequest`	`withDefaultSubstitutions(String defaultSubstitutions)` A JSON object that specifies the default values to use for message variables in the message template.
`VoiceTemplateRequest`	`withLanguageCode(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.
`VoiceTemplateRequest`	`withTags(Map<String,String> tags)`
`VoiceTemplateRequest`	`withTemplateDescription(String templateDescription)` A custom description of the message template.
`VoiceTemplateRequest`	`withVoiceId(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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VoiceTemplateRequest
```
public VoiceTemplateRequest()
```
- Method Detail
  - setBody
```
public void setBody(String body)
```
    The text of the script to use in messages that are based on the message template, in plain text format.
    
    Parameters:
    
    body - The text of the script to use in messages that are based on the message template, in plain text format.
  - getBody
```
public String getBody()
```
    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.
  - withBody
```
public VoiceTemplateRequest withBody(String body)
```
    The text of the script to use in messages that are based on the message template, in plain text format.
    
    Parameters:
    
    body - The text of the script to use in messages that are based on the message template, in plain text format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultSubstitutions
```
public void setDefaultSubstitutions(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.
    
    Parameters:
    
    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.
  - getDefaultSubstitutions
```
public String getDefaultSubstitutions()
```
    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.
  - withDefaultSubstitutions
```
public VoiceTemplateRequest withDefaultSubstitutions(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLanguageCode
```
public void setLanguageCode(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.
    
    Parameters:
    
    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.
  - getLanguageCode
```
public String getLanguageCode()
```
    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.
  - withLanguageCode
```
public VoiceTemplateRequest withLanguageCode(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    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.
    
    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.
  - setTags
```
public void setTags(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.
    
    Parameters:
    
    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.
  - withTags
```
public VoiceTemplateRequest withTags(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public VoiceTemplateRequest addTagsEntry(String key,
                                         String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public VoiceTemplateRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateDescription
```
public void setTemplateDescription(String templateDescription)
```
    A custom description of the message template.
    
    Parameters:
    
    templateDescription - A custom description of the message template.
  - getTemplateDescription
```
public String getTemplateDescription()
```
    A custom description of the message template.
    
    Returns:
    
    A custom description of the message template.
  - withTemplateDescription
```
public VoiceTemplateRequest withTemplateDescription(String templateDescription)
```
    A custom description of the message template.
    
    Parameters:
    
    templateDescription - A custom description of the message template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVoiceId
```
public void setVoiceId(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.
    
    Parameters:
    
    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.
  - getVoiceId
```
public String getVoiceId()
```
    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.
  - withVoiceId
```
public VoiceTemplateRequest withVoiceId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public VoiceTemplateRequest clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class VoiceTemplateRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VoiceTemplateRequest

Method Detail

setBody

getBody

withBody

setDefaultSubstitutions

getDefaultSubstitutions

withDefaultSubstitutions

setLanguageCode

getLanguageCode

withLanguageCode

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setTemplateDescription

getTemplateDescription

withTemplateDescription

setVoiceId

getVoiceId

withVoiceId

toString

equals

hashCode

clone

marshall