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

Interface Activity.Builder

All Superinterfaces:

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

Enclosing class:

Activity

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

Method Summary

Modifier and Type	Method	Description
default Activity.Builder	conditionalSplit(Consumer<ConditionalSplitActivity.Builder> conditionalSplit)	The settings for a yes/no split activity.
Activity.Builder	conditionalSplit(ConditionalSplitActivity conditionalSplit)	The settings for a yes/no split activity.
default Activity.Builder	contactCenter(Consumer<ContactCenterActivity.Builder> contactCenter)	The settings for a connect activity.
Activity.Builder	contactCenter(ContactCenterActivity contactCenter)	The settings for a connect activity.
default Activity.Builder	custom(Consumer<CustomMessageActivity.Builder> custom)	The settings for a custom message activity.
Activity.Builder	custom(CustomMessageActivity custom)	The settings for a custom message activity.
Activity.Builder	description(String description)	The custom description of the activity.
default Activity.Builder	email(Consumer<EmailMessageActivity.Builder> email)	The settings for an email activity.
Activity.Builder	email(EmailMessageActivity email)	The settings for an email activity.
default Activity.Builder	holdout(Consumer<HoldoutActivity.Builder> holdout)	The settings for a holdout activity.
Activity.Builder	holdout(HoldoutActivity holdout)	The settings for a holdout activity.
default Activity.Builder	multiCondition(Consumer<MultiConditionalSplitActivity.Builder> multiCondition)	The settings for a multivariate split activity.
Activity.Builder	multiCondition(MultiConditionalSplitActivity multiCondition)	The settings for a multivariate split activity.
default Activity.Builder	push(Consumer<PushMessageActivity.Builder> push)	The settings for a push notification activity.
Activity.Builder	push(PushMessageActivity push)	The settings for a push notification activity.
default Activity.Builder	randomSplit(Consumer<RandomSplitActivity.Builder> randomSplit)	The settings for a random split activity.
Activity.Builder	randomSplit(RandomSplitActivity randomSplit)	The settings for a random split activity.
default Activity.Builder	sms(Consumer<SMSMessageActivity.Builder> sms)	The settings for an SMS activity.
Activity.Builder	sms(SMSMessageActivity sms)	The settings for an SMS activity.
default Activity.Builder	waitValue(Consumer<WaitActivity.Builder> wait)	The settings for a wait activity.
Activity.Builder	waitValue(WaitActivity wait)	The settings for a wait activity.

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 Details

custom

Activity.Builder custom(CustomMessageActivity custom)

The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

Parameters:

custom - The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

Returns:

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

custom

default Activity.Builder custom(Consumer<CustomMessageActivity.Builder> custom)

The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

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

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

Parameters:

custom - a consumer that will call methods on CustomMessageActivity.Builder

Returns:

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

See Also:

• custom(CustomMessageActivity)

conditionalSplit

Activity.Builder conditionalSplit(ConditionalSplitActivity conditionalSplit)

The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

Parameters:

conditionalSplit - The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

Returns:

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

conditionalSplit

default Activity.Builder conditionalSplit(Consumer<ConditionalSplitActivity.Builder> conditionalSplit)

The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

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

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

Parameters:

conditionalSplit - a consumer that will call methods on ConditionalSplitActivity.Builder

Returns:

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

See Also:

• conditionalSplit(ConditionalSplitActivity)

description

Activity.Builder description(String description)

The custom description of the activity.

Parameters:

description - The custom description of the activity.

Returns:

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

email

Activity.Builder email(EmailMessageActivity email)

The settings for an email activity. This type of activity sends an email message to participants.

Parameters:

email - The settings for an email activity. This type of activity sends an email message to participants.

Returns:

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

email

default Activity.Builder email(Consumer<EmailMessageActivity.Builder> email)

The settings for an email activity. This type of activity sends an email message to participants.

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

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

Parameters:

email - a consumer that will call methods on EmailMessageActivity.Builder

Returns:

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

See Also:

• email(EmailMessageActivity)

holdout

Activity.Builder holdout(HoldoutActivity holdout)

The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

Parameters:

holdout - The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

Returns:

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

holdout

default Activity.Builder holdout(Consumer<HoldoutActivity.Builder> holdout)

The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

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

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

Parameters:

holdout - a consumer that will call methods on HoldoutActivity.Builder

Returns:

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

See Also:

• holdout(HoldoutActivity)

multiCondition

Activity.Builder multiCondition(MultiConditionalSplitActivity multiCondition)

The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

Parameters:

multiCondition - The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

Returns:

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

multiCondition

default Activity.Builder multiCondition(Consumer<MultiConditionalSplitActivity.Builder> multiCondition)

The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

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

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

Parameters:

multiCondition - a consumer that will call methods on MultiConditionalSplitActivity.Builder

Returns:

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

See Also:

• multiCondition(MultiConditionalSplitActivity)

push

Activity.Builder push(PushMessageActivity push)

The settings for a push notification activity. This type of activity sends a push notification to participants.

Parameters:

push - The settings for a push notification activity. This type of activity sends a push notification to participants.

Returns:

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

push

default Activity.Builder push(Consumer<PushMessageActivity.Builder> push)

The settings for a push notification activity. This type of activity sends a push notification to participants.

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

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

Parameters:

push - a consumer that will call methods on PushMessageActivity.Builder

Returns:

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

See Also:

• push(PushMessageActivity)

randomSplit

Activity.Builder randomSplit(RandomSplitActivity randomSplit)

The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

Parameters:

randomSplit - The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

Returns:

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

randomSplit

default Activity.Builder randomSplit(Consumer<RandomSplitActivity.Builder> randomSplit)

The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

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

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

Parameters:

randomSplit - a consumer that will call methods on RandomSplitActivity.Builder

Returns:

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

See Also:

• randomSplit(RandomSplitActivity)

sms

Activity.Builder sms(SMSMessageActivity sms)

The settings for an SMS activity. This type of activity sends a text message to participants.

Parameters:

sms - The settings for an SMS activity. This type of activity sends a text message to participants.

Returns:

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

sms

default Activity.Builder sms(Consumer<SMSMessageActivity.Builder> sms)

The settings for an SMS activity. This type of activity sends a text message to participants.

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

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

Parameters:

sms - a consumer that will call methods on SMSMessageActivity.Builder

Returns:

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

See Also:

• sms(SMSMessageActivity)

waitValue

Activity.Builder waitValue(WaitActivity wait)

The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

Parameters:

wait - The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

Returns:

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

waitValue

default Activity.Builder waitValue(Consumer<WaitActivity.Builder> wait)

The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

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

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

Parameters:

wait - a consumer that will call methods on WaitActivity.Builder

Returns:

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

See Also:

• waitValue(WaitActivity)

contactCenter

Activity.Builder contactCenter(ContactCenterActivity contactCenter)

The settings for a connect activity. This type of activity initiates a contact center call to participants.

Parameters:

contactCenter - The settings for a connect activity. This type of activity initiates a contact center call to participants.

Returns:

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

contactCenter

default Activity.Builder contactCenter(Consumer<ContactCenterActivity.Builder> contactCenter)

The settings for a connect activity. This type of activity initiates a contact center call to participants.

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

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

Parameters:

contactCenter - a consumer that will call methods on ContactCenterActivity.Builder

Returns:

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

See Also:

• contactCenter(ContactCenterActivity)