@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class TemplateResponse extends Object implements Serializable, Cloneable, StructuredPojo
Provides information about a message template that's associated with your Amazon Pinpoint account.
Constructor and Description |
---|
TemplateResponse() |
Modifier and Type | Method and Description |
---|---|
TemplateResponse |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
TemplateResponse |
clearTagsEntries()
Removes all the entries added into Tags.
|
TemplateResponse |
clone() |
boolean |
equals(Object obj) |
String |
getArn()
The Amazon Resource Name (ARN) of the message template.
|
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 |
getLastModifiedDate()
The date, in ISO 8601 format, when the message template was last modified.
|
Map<String,String> |
getTags()
A 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.
|
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 |
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 |
setLastModifiedDate(String lastModifiedDate)
The date, in ISO 8601 format, when the message template was last modified.
|
void |
setTags(Map<String,String> tags)
A 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.
|
String |
toString()
Returns a string representation of this object.
|
TemplateResponse |
withArn(String arn)
The Amazon Resource Name (ARN) of the message template.
|
TemplateResponse |
withCreationDate(String creationDate)
The date, in ISO 8601 format, when the message template was created.
|
TemplateResponse |
withDefaultSubstitutions(String defaultSubstitutions)
The JSON object that specifies the default values that are used for message variables in the message template.
|
TemplateResponse |
withLastModifiedDate(String lastModifiedDate)
The date, in ISO 8601 format, when the message template was last modified.
|
TemplateResponse |
withTags(Map<String,String> tags)
A map of key-value pairs that identifies the tags that are associated with the message template.
|
TemplateResponse |
withTemplateDescription(String templateDescription)
The custom description of the message template.
|
TemplateResponse |
withTemplateName(String templateName)
The name of the message template.
|
TemplateResponse |
withTemplateType(String templateType)
The type of channel that the message template is designed for.
|
TemplateResponse |
withTemplateType(TemplateType templateType)
The type of channel that the message template is designed for.
|
TemplateResponse |
withVersion(String version)
The unique identifier, as an integer, for the active version of the message template.
|
public void setArn(String arn)
The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.
arn
- The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse
object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or
GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.public String getArn()
The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.
public TemplateResponse withArn(String arn)
The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.
arn
- The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse
object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or
GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.public void setCreationDate(String creationDate)
The date, in ISO 8601 format, when the message template was created.
creationDate
- The date, in ISO 8601 format, when the message template was created.public String getCreationDate()
The date, in ISO 8601 format, when the message template was created.
public TemplateResponse withCreationDate(String creationDate)
The date, in ISO 8601 format, when the message template was created.
creationDate
- The date, in ISO 8601 format, when the message template was created.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 isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
defaultSubstitutions
- The JSON object that specifies the default values that are used for message variables in the message
template. This object isn't included in a TemplateResponse object. To retrieve this object for a template,
use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the
type of template that you want to retrieve the object for.public String getDefaultSubstitutions()
The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
public TemplateResponse withDefaultSubstitutions(String defaultSubstitutions)
The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
defaultSubstitutions
- The JSON object that specifies the default values that are used for message variables in the message
template. This object isn't included in a TemplateResponse object. To retrieve this object for a template,
use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the
type of template that you want to retrieve the object for.public void setLastModifiedDate(String lastModifiedDate)
The date, in ISO 8601 format, when the message template was last modified.
lastModifiedDate
- The date, in ISO 8601 format, when the message template was last modified.public String getLastModifiedDate()
The date, in ISO 8601 format, when the message template was last modified.
public TemplateResponse withLastModifiedDate(String lastModifiedDate)
The date, in ISO 8601 format, when the message template was last modified.
lastModifiedDate
- The date, in ISO 8601 format, when the message template was last modified.public Map<String,String> getTags()
A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
public void setTags(Map<String,String> tags)
A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
tags
- A map of key-value pairs that identifies the tags that are associated with the message template. This
object isn't included in a TemplateResponse object. To retrieve this object for a template, use the
GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of
template that you want to retrieve the object for.public TemplateResponse withTags(Map<String,String> tags)
A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
tags
- A map of key-value pairs that identifies the tags that are associated with the message template. This
object isn't included in a TemplateResponse object. To retrieve this object for a template, use the
GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of
template that you want to retrieve the object for.public TemplateResponse addTagsEntry(String key, String value)
public TemplateResponse clearTagsEntries()
public void setTemplateDescription(String templateDescription)
The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.
templateDescription
- The custom description of the message template. This value isn't included in a TemplateResponse object. To
retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or
GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description
for.public String getTemplateDescription()
The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.
public TemplateResponse withTemplateDescription(String templateDescription)
The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.
templateDescription
- The custom description of the message template. This value isn't included in a TemplateResponse object. To
retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or
GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description
for.public void setTemplateName(String templateName)
The name of the message template.
templateName
- The name of the message template.public String getTemplateName()
The name of the message template.
public TemplateResponse withTemplateName(String templateName)
The name of the message template.
templateName
- The name of the message template.public void setTemplateType(String templateType)
The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.
templateType
- The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS,
INAPP, and VOICE.TemplateType
public String getTemplateType()
The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.
TemplateType
public TemplateResponse withTemplateType(String templateType)
The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.
templateType
- The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS,
INAPP, and VOICE.TemplateType
public TemplateResponse withTemplateType(TemplateType templateType)
The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.
templateType
- The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS,
INAPP, and VOICE.TemplateType
public void setVersion(String version)
The unique identifier, as an integer, for the active version of the message template.
version
- The unique identifier, as an integer, for the active version of the message template.public String getVersion()
The unique identifier, as an integer, for the active version of the message template.
public TemplateResponse withVersion(String version)
The unique identifier, as an integer, for the active version of the message template.
version
- The unique identifier, as an integer, for the active version of the message template.public String toString()
toString
in class Object
Object.toString()
public TemplateResponse clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.