software.amazon.awssdk.services.pinpoint.model

Interface SMSMessage.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SMSMessage.Builder,SMSMessage>, SdkBuilder<SMSMessage.Builder,SMSMessage>, SdkPojo

Enclosing class:

SMSMessage

public static interface SMSMessage.Builder
extends SdkPojo, CopyableBuilder<SMSMessage.Builder,SMSMessage>

Method Summary

Modifier and Type	Method and Description
SMSMessage.Builder	body(String body) The body of the SMS message.
SMSMessage.Builder	keyword(String keyword) The SMS program name that you provided to AWS Support when you requested your dedicated number.
SMSMessage.Builder	messageType(MessageType messageType) The SMS message type.
SMSMessage.Builder	messageType(String messageType) The SMS message type.
SMSMessage.Builder	originationNumber(String originationNumber) The number to send the SMS message from.
SMSMessage.Builder	senderId(String senderId) The sender ID to display as the sender of the message on a recipient's device.
SMSMessage.Builder	substitutions(Map<String,? extends Collection<String>> substitutions) The message variables to use in the SMS message.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

body

SMSMessage.Builder body(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.

keyword

SMSMessage.Builder keyword(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.

messageType

SMSMessage.Builder messageType(String messageType)

The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message.

Parameters:

messageType - The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MessageType, MessageType

messageType

SMSMessage.Builder messageType(MessageType messageType)

The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message.

Parameters:

messageType - The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MessageType, MessageType

originationNumber

SMSMessage.Builder originationNumber(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.

senderId

SMSMessage.Builder senderId(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.

substitutions

SMSMessage.Builder substitutions(Map<String,? extends Collection<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.