SMSTemplateResponse (AWS SDK for Java

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

All Implemented Interfaces:

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SMSTemplateResponse()

Constructors
Constructor and Description
`SMSTemplateResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SMSTemplateResponse`	`addTagsEntry(String key, String value)`
`SMSTemplateResponse`	`clearTagsEntries()` Removes all the entries added into Tags.
`SMSTemplateResponse`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the message template.
`String`	`getBody()` The message body that's used in text messages that are based on the message template.
`String`	`getCreationDate()` The date 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 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.
`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 message body that's used in text messages that are based on the message template.
`void`	`setCreationDate(String creationDate)` The date 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 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.
`String`	`toString()` Returns a string representation of this object.
`SMSTemplateResponse`	`withArn(String arn)` The Amazon Resource Name (ARN) of the message template.
`SMSTemplateResponse`	`withBody(String body)` The message body that's used in text messages that are based on the message template.
`SMSTemplateResponse`	`withCreationDate(String creationDate)` The date when the message template was created.
`SMSTemplateResponse`	`withDefaultSubstitutions(String defaultSubstitutions)` The JSON object that specifies the default values that are used for message variables in the message template.
`SMSTemplateResponse`	`withLastModifiedDate(String lastModifiedDate)` The date when the message template was last modified.
`SMSTemplateResponse`	`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.
`SMSTemplateResponse`	`withTemplateDescription(String templateDescription)` The custom description of the message template.
`SMSTemplateResponse`	`withTemplateName(String templateName)` The name of the message template.
`SMSTemplateResponse`	`withTemplateType(String templateType)` The type of channel that the message template is designed for.
`SMSTemplateResponse`	`withTemplateType(TemplateType templateType)` The type of channel that the message template is designed for.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SMSTemplateResponse
```
public SMSTemplateResponse()
```
- 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 SMSTemplateResponse 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 message body that's used in text messages that are based on the message template.
    
    Parameters:
    
    body - The message body that's used in text messages that are based on the message template.
  - getBody
```
public String getBody()
```
    The message body that's used in text messages that are based on the message template.
    
    Returns:
    
    The message body that's used in text messages that are based on the message template.
  - withBody
```
public SMSTemplateResponse withBody(String body)
```
    The message body that's used in text messages that are based on the message template.
    
    Parameters:
    
    body - The message body that's used in text messages that are based on the message template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(String creationDate)
```
    The date when the message template was created.
    
    Parameters:
    
    creationDate - The date when the message template was created.
  - getCreationDate
```
public String getCreationDate()
```
    The date when the message template was created.
    
    Returns:
    
    The date when the message template was created.
  - withCreationDate
```
public SMSTemplateResponse withCreationDate(String creationDate)
```
    The date when the message template was created.
    
    Parameters:
    
    creationDate - The date 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 SMSTemplateResponse 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.
  - setLastModifiedDate
```
public void setLastModifiedDate(String lastModifiedDate)
```
    The date when the message template was last modified.
    
    Parameters:
    
    lastModifiedDate - The date when the message template was last modified.
  - getLastModifiedDate
```
public String getLastModifiedDate()
```
    The date when the message template was last modified.
    
    Returns:
    
    The date when the message template was last modified.
  - withLastModifiedDate
```
public SMSTemplateResponse withLastModifiedDate(String lastModifiedDate)
```
    The date when the message template was last modified.
    
    Parameters:
    
    lastModifiedDate - The date 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 SMSTemplateResponse 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 SMSTemplateResponse addTagsEntry(String key,
                                        String value)
```
  - clearTagsEntries
```
public SMSTemplateResponse 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 SMSTemplateResponse 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 SMSTemplateResponse 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 an SMS template, this value is SMS.
    
    Parameters:
    
    templateType - The type of channel that the message template is designed for. For an SMS template, this value is SMS.
    
    See Also:
    
    TemplateType
  - getTemplateType
```
public String getTemplateType()
```
    The type of channel that the message template is designed for. For an SMS template, this value is SMS.
    
    Returns:
    
    The type of channel that the message template is designed for. For an SMS template, this value is SMS.
    
    See Also:
    
    TemplateType
  - withTemplateType
```
public SMSTemplateResponse withTemplateType(String templateType)
```
    The type of channel that the message template is designed for. For an SMS template, this value is SMS.
    
    Parameters:
    
    templateType - The type of channel that the message template is designed for. For an SMS template, this value is SMS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TemplateType
  - withTemplateType
```
public SMSTemplateResponse withTemplateType(TemplateType templateType)
```
    The type of channel that the message template is designed for. For an SMS template, this value is SMS.
    
    Parameters:
    
    templateType - The type of channel that the message template is designed for. For an SMS template, this value is SMS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TemplateType
  - 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 SMSTemplateResponse 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 SMSTemplateResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SMSTemplateResponse

Method Detail

setArn

getArn

withArn

setBody

getBody

withBody

setCreationDate

getCreationDate

withCreationDate

setDefaultSubstitutions

getDefaultSubstitutions

withDefaultSubstitutions

setLastModifiedDate

getLastModifiedDate

withLastModifiedDate

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setTemplateDescription

getTemplateDescription

withTemplateDescription

setTemplateName

getTemplateName

withTemplateName

setTemplateType

getTemplateType

withTemplateType

withTemplateType

toString

equals

hashCode

clone

marshall