CampaignSmsMessage (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CampaignSmsMessage
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies the content and settings for an SMS message that's sent to recipients of a campaign.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CampaignSmsMessage()

Constructors
Constructor and Description
`CampaignSmsMessage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CampaignSmsMessage`	`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`	`getMessageType()` The SMS message type.
`String`	`getOriginationNumber()` The long code to send the SMS message from.
`String`	`getSenderId()` The sender ID to display on recipients' devices when they receive 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`	`setMessageType(MessageType messageType)` The SMS message type.
`void`	`setMessageType(String messageType)` The SMS message type.
`void`	`setOriginationNumber(String originationNumber)` The long code to send the SMS message from.
`void`	`setSenderId(String senderId)` The sender ID to display on recipients' devices when they receive 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.
`CampaignSmsMessage`	`withBody(String body)` The body of the SMS message.
`CampaignSmsMessage`	`withEntityId(String entityId)` The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
`CampaignSmsMessage`	`withMessageType(MessageType messageType)` The SMS message type.
`CampaignSmsMessage`	`withMessageType(String messageType)` The SMS message type.
`CampaignSmsMessage`	`withOriginationNumber(String originationNumber)` The long code to send the SMS message from.
`CampaignSmsMessage`	`withSenderId(String senderId)` The sender ID to display on recipients' devices when they receive the SMS message.
`CampaignSmsMessage`	`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
  - CampaignSmsMessage
```
public CampaignSmsMessage()
```
- 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 CampaignSmsMessage 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.
  - 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 CampaignSmsMessage 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 CampaignSmsMessage 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 long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
    
    Parameters:
    
    originationNumber - The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
  - getOriginationNumber
```
public String getOriginationNumber()
```
    The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
    
    Returns:
    
    The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
  - withOriginationNumber
```
public CampaignSmsMessage withOriginationNumber(String originationNumber)
```
    The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
    
    Parameters:
    
    originationNumber - The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
    
    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 on recipients' devices when they receive the SMS message.
    
    Parameters:
    
    senderId - The sender ID to display on recipients' devices when they receive the SMS message.
  - getSenderId
```
public String getSenderId()
```
    The sender ID to display on recipients' devices when they receive the SMS message.
    
    Returns:
    
    The sender ID to display on recipients' devices when they receive the SMS message.
  - withSenderId
```
public CampaignSmsMessage withSenderId(String senderId)
```
    The sender ID to display on recipients' devices when they receive the SMS message.
    
    Parameters:
    
    senderId - The sender ID to display on recipients' devices when they receive the SMS message.
    
    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 CampaignSmsMessage 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 CampaignSmsMessage 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 CampaignSmsMessage 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 CampaignSmsMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CampaignSmsMessage

Method Detail

setBody

getBody

withBody

setMessageType

getMessageType

withMessageType

setMessageType

withMessageType

setOriginationNumber

getOriginationNumber

withOriginationNumber

setSenderId

getSenderId

withSenderId

setEntityId

getEntityId

withEntityId

setTemplateId

getTemplateId

withTemplateId

toString

equals

hashCode

clone

marshall