Package software.amazon.awssdk.services.pinpoint.model

Class CampaignSmsMessage

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.CampaignSmsMessage

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CampaignSmsMessage.Builder,CampaignSmsMessage>

@Generated("software.amazon.awssdk:codegen")
public final class CampaignSmsMessage
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CampaignSmsMessage.Builder,CampaignSmsMessage>

Specifies the content and settings for an SMS message that's sent to recipients of a campaign.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CampaignSmsMessage.Builder

Method Summary

Modifier and Type	Method	Description
String	body()	The body of the SMS message.
static CampaignSmsMessage.Builder	builder()
String	entityId()	The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
MessageType	messageType()	The SMS message type.
String	messageTypeAsString()	The SMS message type.
String	originationNumber()	The long code to send the SMS message from.
List<SdkField<?>>	sdkFields()
String	senderId()	The sender ID to display on recipients' devices when they receive the SMS message.
static Class<? extends CampaignSmsMessage.Builder>	serializableBuilderClass()
String	templateId()	The template ID received from the regulatory body for sending SMS in your country.
CampaignSmsMessage.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

body

public final String body()

The body of the SMS message.

Returns:

The body of the SMS message.

messageType

public final 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).

If the service returns an enum value that is not available in the current SDK version, messageType will return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageTypeAsString().

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

messageTypeAsString

public final String messageTypeAsString()

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).

If the service returns an enum value that is not available in the current SDK version, messageType will return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageTypeAsString().

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

originationNumber

public final 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.

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.

senderId

public final String senderId()

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.

entityId

public final String entityId()

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.

templateId

public final String templateId()

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.

toBuilder

public CampaignSmsMessage.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CampaignSmsMessage.Builder,CampaignSmsMessage>

builder

public static CampaignSmsMessage.Builder builder()

serializableBuilderClass

public static Class<? extends CampaignSmsMessage.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo