VoiceTemplateResponse (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class VoiceTemplateResponse
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

VoiceTemplateResponse()

Constructors
Constructor and Description
`VoiceTemplateResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VoiceTemplateResponse`	`addTagsEntry(String key, String value)` Add a single Tags entry
`VoiceTemplateResponse`	`clearTagsEntries()` Removes all the entries added into Tags.
`VoiceTemplateResponse`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the message template.
`String`	`getBody()` The text of the script that's used in messages that are based on the message template, in plain text format.
`String`	`getCreationDate()` The date, in ISO 8601 format, when the message template was created.
`String`	`getDefaultSubstitutions()` The JSON object that specifies the default values that are used for message variables in the message template.
`String`	`getLanguageCode()` 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`	`getLastModifiedDate()` The date, in ISO 8601 format, when the message template was last modified.
`Map<String,String>`	`getTags()` A string-to-string map of key-value pairs that identifies the tags that are associated with the message template.
`String`	`getTemplateDescription()` The custom description of the message template.
`String`	`getTemplateName()` The name of the message template.
`String`	`getTemplateType()` The type of channel that the message template is designed for.
`String`	`getVersion()` 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`	`getVoiceId()` The name of the voice that's used 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`	`setArn(String arn)` The Amazon Resource Name (ARN) of the message template.
`void`	`setBody(String body)` The text of the script that's used in messages that are based on the message template, in plain text format.
`void`	`setCreationDate(String creationDate)` The date, in ISO 8601 format, when the message template was created.
`void`	`setDefaultSubstitutions(String defaultSubstitutions)` The JSON object that specifies the default values that are used for message variables in the message template.
`void`	`setLanguageCode(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.
`void`	`setLastModifiedDate(String lastModifiedDate)` The date, in ISO 8601 format, when the message template was last modified.
`void`	`setTags(Map<String,String> tags)` A string-to-string map of key-value pairs that identifies the tags that are associated with the message template.
`void`	`setTemplateDescription(String templateDescription)` The custom description of the message template.
`void`	`setTemplateName(String templateName)` The name of the message template.
`void`	`setTemplateType(String templateType)` The type of channel that the message template is designed for.
`void`	`setVersion(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.
`void`	`setVoiceId(String voiceId)` The name of the voice that's used when delivering messages that are based on the message template.
`String`	`toString()` Returns a string representation of this object.
`VoiceTemplateResponse`	`withArn(String arn)` The Amazon Resource Name (ARN) of the message template.
`VoiceTemplateResponse`	`withBody(String body)` The text of the script that's used in messages that are based on the message template, in plain text format.
`VoiceTemplateResponse`	`withCreationDate(String creationDate)` The date, in ISO 8601 format, when the message template was created.
`VoiceTemplateResponse`	`withDefaultSubstitutions(String defaultSubstitutions)` The JSON object that specifies the default values that are used for message variables in the message template.
`VoiceTemplateResponse`	`withLanguageCode(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.
`VoiceTemplateResponse`	`withLastModifiedDate(String lastModifiedDate)` The date, in ISO 8601 format, when the message template was last modified.
`VoiceTemplateResponse`	`withTags(Map<String,String> tags)` A string-to-string map of key-value pairs that identifies the tags that are associated with the message template.
`VoiceTemplateResponse`	`withTemplateDescription(String templateDescription)` The custom description of the message template.
`VoiceTemplateResponse`	`withTemplateName(String templateName)` The name of the message template.
`VoiceTemplateResponse`	`withTemplateType(String templateType)` The type of channel that the message template is designed for.
`VoiceTemplateResponse`	`withTemplateType(TemplateType templateType)` The type of channel that the message template is designed for.
`VoiceTemplateResponse`	`withVersion(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.
`VoiceTemplateResponse`	`withVoiceId(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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VoiceTemplateResponse
```
public VoiceTemplateResponse()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the message template.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the message template.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the message template.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the message template.
  - withArn
```
public VoiceTemplateResponse withArn(String arn)
```
    The Amazon Resource Name (ARN) of the message template.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the message template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBody
```
public void setBody(String body)
```
    The text of the script that's used in messages that are based on the message template, in plain text format.
    
    Parameters:
    
    body - The text of the script that's used in messages that are based on the message template, in plain text format.
  - getBody
```
public String getBody()
```
    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.
  - withBody
```
public VoiceTemplateResponse withBody(String body)
```
    The text of the script that's used in messages that are based on the message template, in plain text format.
    
    Parameters:
    
    body - The text of the script that's used 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.
  - setCreationDate
```
public void setCreationDate(String creationDate)
```
    The date, in ISO 8601 format, when the message template was created.
    
    Parameters:
    
    creationDate - The date, in ISO 8601 format, when the message template was created.
  - getCreationDate
```
public String getCreationDate()
```
    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.
  - withCreationDate
```
public VoiceTemplateResponse withCreationDate(String creationDate)
```
    The date, in ISO 8601 format, when the message template was created.
    
    Parameters:
    
    creationDate - The date, in ISO 8601 format, when the message template was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultSubstitutions
```
public void setDefaultSubstitutions(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.
    
    Parameters:
    
    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.
  - getDefaultSubstitutions
```
public String getDefaultSubstitutions()
```
    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.
  - withDefaultSubstitutions
```
public VoiceTemplateResponse withDefaultSubstitutions(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.
    
    Parameters:
    
    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:
    
    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 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.
    
    Parameters:
    
    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.
  - getLanguageCode
```
public String getLanguageCode()
```
    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.
  - withLanguageCode
```
public VoiceTemplateResponse withLanguageCode(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedDate
```
public void setLastModifiedDate(String lastModifiedDate)
```
    The date, in ISO 8601 format, when the message template was last modified.
    
    Parameters:
    
    lastModifiedDate - The date, in ISO 8601 format, when the message template was last modified.
  - getLastModifiedDate
```
public String getLastModifiedDate()
```
    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.
  - withLastModifiedDate
```
public VoiceTemplateResponse withLastModifiedDate(String lastModifiedDate)
```
    The date, in ISO 8601 format, when the message template was last modified.
    
    Parameters:
    
    lastModifiedDate - The date, in ISO 8601 format, when the message template was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    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.
    
    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.
  - setTags
```
public void setTags(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.
    
    Parameters:
    
    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.
  - withTags
```
public VoiceTemplateResponse withTags(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public VoiceTemplateResponse addTagsEntry(String key,
                                          String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public VoiceTemplateResponse 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)
```
    The custom description of the message template.
    
    Parameters:
    
    templateDescription - The custom description of the message template.
  - getTemplateDescription
```
public String getTemplateDescription()
```
    The custom description of the message template.
    
    Returns:
    
    The custom description of the message template.
  - withTemplateDescription
```
public VoiceTemplateResponse withTemplateDescription(String templateDescription)
```
    The custom description of the message template.
    
    Parameters:
    
    templateDescription - The custom description of the message template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateName
```
public void setTemplateName(String templateName)
```
    The name of the message template.
    
    Parameters:
    
    templateName - The name of the message template.
  - getTemplateName
```
public String getTemplateName()
```
    The name of the message template.
    
    Returns:
    
    The name of the message template.
  - withTemplateName
```
public VoiceTemplateResponse withTemplateName(String templateName)
```
    The name of the message template.
    
    Parameters:
    
    templateName - The name of the message template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateType
```
public void setTemplateType(String templateType)
```
    The type of channel that the message template is designed for. For a voice template, this value is VOICE.
    
    Parameters:
    
    templateType - The type of channel that the message template is designed for. For a voice template, this value is VOICE.
    
    See Also:
    
    TemplateType
  - getTemplateType
```
public String getTemplateType()
```
    The type of channel that the message template is designed for. For a voice template, this value is VOICE.
    
    Returns:
    
    The type of channel that the message template is designed for. For a voice template, this value is VOICE.
    
    See Also:
    
    TemplateType
  - withTemplateType
```
public VoiceTemplateResponse withTemplateType(String templateType)
```
    The type of channel that the message template is designed for. For a voice template, this value is VOICE.
    
    Parameters:
    
    templateType - The type of channel that the message template is designed for. For a voice template, this value is VOICE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TemplateType
  - withTemplateType
```
public VoiceTemplateResponse withTemplateType(TemplateType templateType)
```
    The type of channel that the message template is designed for. For a voice template, this value is VOICE.
    
    Parameters:
    
    templateType - The type of channel that the message template is designed for. For a voice template, this value is VOICE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TemplateType
  - setVersion
```
public void setVersion(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.
    
    Parameters:
    
    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.
  - getVersion
```
public String getVersion()
```
    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.
  - withVersion
```
public VoiceTemplateResponse withVersion(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.
    
    Parameters:
    
    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:
    
    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 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.
    
    Parameters:
    
    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.
  - getVoiceId
```
public String getVoiceId()
```
    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.
  - withVoiceId
```
public VoiceTemplateResponse withVoiceId(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.
    
    Parameters:
    
    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:
    
    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 VoiceTemplateResponse 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.

Did this page help you?

Class VoiceTemplateResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VoiceTemplateResponse

Method Detail

setArn

getArn

withArn

setBody

getBody

withBody

setCreationDate

getCreationDate

withCreationDate

setDefaultSubstitutions

getDefaultSubstitutions

withDefaultSubstitutions

setLanguageCode

getLanguageCode

withLanguageCode

setLastModifiedDate

getLastModifiedDate

withLastModifiedDate

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setTemplateDescription

getTemplateDescription

withTemplateDescription

setTemplateName

getTemplateName

withTemplateName

setTemplateType

getTemplateType

withTemplateType

withTemplateType

setVersion

getVersion

withVersion

setVoiceId

getVoiceId

withVoiceId

toString

equals

hashCode

clone

marshall