SMSMessage (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SMSMessage
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies the default settings for a one-time SMS message that's sent directly to an endpoint.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SMSMessage()

Constructors
Constructor and Description
`SMSMessage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SMSMessage`	`addSubstitutionsEntry(String key, List<String> value)` Add a single Substitutions entry
`SMSMessage`	`clearSubstitutionsEntries()` Removes all the entries added into Substitutions.
`SMSMessage`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBody()` The body of the SMS message.
`String`	`getEntityId()` The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
`String`	`getKeyword()` The SMS program name that you provided to AWS Support when you requested your dedicated number.
`String`	`getMediaUrl()` This field is reserved for future use.
`String`	`getMessageType()` The SMS message type.
`String`	`getOriginationNumber()` The number to send the SMS message from.
`String`	`getSenderId()` The sender ID to display as the sender of the message on a recipient's device.
`Map<String,List<String>>`	`getSubstitutions()` The message variables to use in the SMS message.
`String`	`getTemplateId()` The template ID received from the regulatory body for sending SMS in your country.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBody(String body)` The body of the SMS message.
`void`	`setEntityId(String entityId)` The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
`void`	`setKeyword(String keyword)` The SMS program name that you provided to AWS Support when you requested your dedicated number.
`void`	`setMediaUrl(String mediaUrl)` This field is reserved for future use.
`void`	`setMessageType(MessageType messageType)` The SMS message type.
`void`	`setMessageType(String messageType)` The SMS message type.
`void`	`setOriginationNumber(String originationNumber)` The number to send the SMS message from.
`void`	`setSenderId(String senderId)` The sender ID to display as the sender of the message on a recipient's device.
`void`	`setSubstitutions(Map<String,List<String>> substitutions)` The message variables to use in the SMS message.
`void`	`setTemplateId(String templateId)` The template ID received from the regulatory body for sending SMS in your country.
`String`	`toString()` Returns a string representation of this object.
`SMSMessage`	`withBody(String body)` The body of the SMS message.
`SMSMessage`	`withEntityId(String entityId)` The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
`SMSMessage`	`withKeyword(String keyword)` The SMS program name that you provided to AWS Support when you requested your dedicated number.
`SMSMessage`	`withMediaUrl(String mediaUrl)` This field is reserved for future use.
`SMSMessage`	`withMessageType(MessageType messageType)` The SMS message type.
`SMSMessage`	`withMessageType(String messageType)` The SMS message type.
`SMSMessage`	`withOriginationNumber(String originationNumber)` The number to send the SMS message from.
`SMSMessage`	`withSenderId(String senderId)` The sender ID to display as the sender of the message on a recipient's device.
`SMSMessage`	`withSubstitutions(Map<String,List<String>> substitutions)` The message variables to use in the SMS message.
`SMSMessage`	`withTemplateId(String templateId)` The template ID received from the regulatory body for sending SMS in your country.

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

- Constructor Detail
  - SMSMessage
```
public SMSMessage()
```
- Method Detail
  - setBody
```
public void setBody(String body)
```
    The body of the SMS message.
    
    Parameters:
    
    body - The body of the SMS message.
  - getBody
```
public String getBody()
```
    The body of the SMS message.
    
    Returns:
    
    The body of the SMS message.
  - withBody
```
public SMSMessage withBody(String body)
```
    The body of the SMS message.
    
    Parameters:
    
    body - The body of the SMS message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyword
```
public void setKeyword(String keyword)
```
    The SMS program name that you provided to AWS Support when you requested your dedicated number.
    
    Parameters:
    
    keyword - The SMS program name that you provided to AWS Support when you requested your dedicated number.
  - getKeyword
```
public String getKeyword()
```
    The SMS program name that you provided to AWS Support when you requested your dedicated number.
    
    Returns:
    
    The SMS program name that you provided to AWS Support when you requested your dedicated number.
  - withKeyword
```
public SMSMessage withKeyword(String keyword)
```
    The SMS program name that you provided to AWS Support when you requested your dedicated number.
    
    Parameters:
    
    keyword - The SMS program name that you provided to AWS Support when you requested your dedicated number.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMediaUrl
```
public void setMediaUrl(String mediaUrl)
```
    This field is reserved for future use.
    
    Parameters:
    
    mediaUrl - This field is reserved for future use.
  - getMediaUrl
```
public String getMediaUrl()
```
    This field is reserved for future use.
    
    Returns:
    
    This field is reserved for future use.
  - withMediaUrl
```
public SMSMessage withMediaUrl(String mediaUrl)
```
    This field is reserved for future use.
    
    Parameters:
    
    mediaUrl - This field is reserved for future use.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMessageType
```
public void setMessageType(String messageType)
```
    The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
    
    Parameters:
    
    messageType - The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
    
    See Also:
    
    MessageType
  - getMessageType
```
public String getMessageType()
```
    The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
    
    Returns:
    
    The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
    
    See Also:
    
    MessageType
  - withMessageType
```
public SMSMessage withMessageType(String messageType)
```
    The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
    
    Parameters:
    
    messageType - The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MessageType
  - setMessageType
```
public void setMessageType(MessageType messageType)
```
    The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
    
    Parameters:
    
    messageType - The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
    
    See Also:
    
    MessageType
  - withMessageType
```
public SMSMessage withMessageType(MessageType messageType)
```
    The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
    
    Parameters:
    
    messageType - The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MessageType
  - setOriginationNumber
```
public void setOriginationNumber(String originationNumber)
```
    The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
    
    Parameters:
    
    originationNumber - The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
  - getOriginationNumber
```
public String getOriginationNumber()
```
    The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
    
    Returns:
    
    The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
  - withOriginationNumber
```
public SMSMessage withOriginationNumber(String originationNumber)
```
    The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
    
    Parameters:
    
    originationNumber - The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSenderId
```
public void setSenderId(String senderId)
```
    The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
    
    Parameters:
    
    senderId - The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
  - getSenderId
```
public String getSenderId()
```
    The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
    
    Returns:
    
    The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
  - withSenderId
```
public SMSMessage withSenderId(String senderId)
```
    The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
    
    Parameters:
    
    senderId - The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSubstitutions
```
public Map<String,List<String>> getSubstitutions()
```
    The message variables to use in the SMS message. You can override the default variables with individual address variables.
    
    Returns:
    
    The message variables to use in the SMS message. You can override the default variables with individual address variables.
  - setSubstitutions
```
public void setSubstitutions(Map<String,List<String>> substitutions)
```
    The message variables to use in the SMS message. You can override the default variables with individual address variables.
    
    Parameters:
    
    substitutions - The message variables to use in the SMS message. You can override the default variables with individual address variables.
  - withSubstitutions
```
public SMSMessage withSubstitutions(Map<String,List<String>> substitutions)
```
    The message variables to use in the SMS message. You can override the default variables with individual address variables.
    
    Parameters:
    
    substitutions - The message variables to use in the SMS message. You can override the default variables with individual address variables.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addSubstitutionsEntry
```
public SMSMessage addSubstitutionsEntry(String key,
                                        List<String> value)
```
    Add a single Substitutions entry
    
    See Also:
    
    withSubstitutions(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)
  - clearSubstitutionsEntries
```
public SMSMessage clearSubstitutionsEntries()
```
    Removes all the entries added into Substitutions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEntityId
```
public void setEntityId(String entityId)
```
    The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
    
    Parameters:
    
    entityId - The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
  - getEntityId
```
public String getEntityId()
```
    The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
    
    Returns:
    
    The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
  - withEntityId
```
public SMSMessage withEntityId(String entityId)
```
    The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
    
    Parameters:
    
    entityId - The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateId
```
public void setTemplateId(String templateId)
```
    The template ID received from the regulatory body for sending SMS in your country.
    
    Parameters:
    
    templateId - The template ID received from the regulatory body for sending SMS in your country.
  - getTemplateId
```
public String getTemplateId()
```
    The template ID received from the regulatory body for sending SMS in your country.
    
    Returns:
    
    The template ID received from the regulatory body for sending SMS in your country.
  - withTemplateId
```
public SMSMessage withTemplateId(String templateId)
```
    The template ID received from the regulatory body for sending SMS in your country.
    
    Parameters:
    
    templateId - The template ID received from the regulatory body for sending SMS in your country.
    
    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 SMSMessage 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.773

Class SMSMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SMSMessage

Method Detail

setBody

getBody

withBody

setKeyword

getKeyword

withKeyword

setMediaUrl

getMediaUrl

withMediaUrl

setMessageType

getMessageType

withMessageType

setMessageType

withMessageType

setOriginationNumber

getOriginationNumber

withOriginationNumber

setSenderId

getSenderId

withSenderId

getSubstitutions

setSubstitutions

withSubstitutions

addSubstitutionsEntry

clearSubstitutionsEntries

setEntityId

getEntityId

withEntityId

setTemplateId

getTemplateId

withTemplateId

toString

equals

hashCode

clone

marshall