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

Interface SMSMessageActivity.Builder

All Superinterfaces:

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

Enclosing class:

SMSMessageActivity

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

Method Summary

Modifier and Type	Method	Description
default SMSMessageActivity.Builder	messageConfig(Consumer<JourneySMSMessage.Builder> messageConfig)	Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
SMSMessageActivity.Builder	messageConfig(JourneySMSMessage messageConfig)	Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
SMSMessageActivity.Builder	nextActivity(String nextActivity)	The unique identifier for the next activity to perform, after the message is sent.
SMSMessageActivity.Builder	templateName(String templateName)	The name of the SMS message template to use for the message.
SMSMessageActivity.Builder	templateVersion(String templateVersion)	The unique identifier for the version of the SMS template to use for the message.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Detail

messageConfig

SMSMessageActivity.Builder messageConfig(JourneySMSMessage messageConfig)

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

Parameters:

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

Returns:

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

messageConfig

default SMSMessageActivity.Builder messageConfig(Consumer<JourneySMSMessage.Builder> messageConfig)

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

This is a convenience method that creates an instance of the JourneySMSMessage.Builder avoiding the need to create one manually via JourneySMSMessage.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to messageConfig(JourneySMSMessage).

Parameters:

messageConfig - a consumer that will call methods on JourneySMSMessage.Builder

Returns:

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

See Also:

messageConfig(JourneySMSMessage)

nextActivity

SMSMessageActivity.Builder nextActivity(String nextActivity)

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

Parameters:

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

Returns:

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

templateName

SMSMessageActivity.Builder templateName(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.

Parameters:

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:

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

templateVersion

SMSMessageActivity.Builder templateVersion(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.

Parameters:

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:

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