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

Class SMSMessageActivity

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.SMSMessageActivity

All Implemented Interfaces:

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

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

Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SMSMessageActivity.Builder

Method Summary

Modifier and Type	Method	Description
static SMSMessageActivity.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
JourneySMSMessage	messageConfig()	Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
String	nextActivity()	The unique identifier for the next activity to perform, after the message is sent.
List<SdkField<?>>	sdkFields()
static Class<? extends SMSMessageActivity.Builder>	serializableBuilderClass()
String	templateName()	The name of the SMS message template to use for the message.
String	templateVersion()	The unique identifier for the version of the SMS template to use for the message.
SMSMessageActivity.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

messageConfig

public final JourneySMSMessage messageConfig()

Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

Returns:

Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

nextActivity

public final String nextActivity()

The unique identifier for the next activity to perform, after the message is sent.

Returns:

The unique identifier for the next activity to perform, after the message is sent.

templateName

public final String templateName()

The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.

Returns:

The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.

templateVersion

public final String templateVersion()

The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

Returns:

The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

toBuilder

public SMSMessageActivity.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SMSMessageActivity.Builder,SMSMessageActivity>

builder

public static SMSMessageActivity.Builder builder()

serializableBuilderClass

public static Class<? extends SMSMessageActivity.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