software.amazon.awssdk.services.pinpoint.model

Class Activity

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.Activity

All Implemented Interfaces:

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

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

Specifies the configuration and other settings for an activity in a journey.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Activity.Builder

Method Summary

Modifier and Type	Method and Description
static Activity.Builder	builder()
ConditionalSplitActivity	conditionalSplit() The settings for a yes/no split activity.
CustomMessageActivity	custom() The settings for a custom message activity.
String	description() The custom description of the activity.
EmailMessageActivity	email() The settings for an email activity.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
HoldoutActivity	holdout() The settings for a holdout activity.
MultiConditionalSplitActivity	multiCondition() The settings for a multivariate split activity.
PushMessageActivity	push() The settings for a push notification activity.
RandomSplitActivity	randomSplit() The settings for a random split activity.
List<SdkField<?>>	sdkFields()
static Class<? extends Activity.Builder>	serializableBuilderClass()
SMSMessageActivity	sms() The settings for an SMS activity.
Activity.Builder	toBuilder()
String	toString() Returns a string representation of this object.
WaitActivity	waitValue() The settings for a wait activity.

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

custom

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

Returns:

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

conditionalSplit

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

Returns:

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.

description

public final String description()

The custom description of the activity.

Returns:

The custom description of the activity.

email

public final EmailMessageActivity email()

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

Returns:

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

holdout

public final HoldoutActivity holdout()

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

Returns:

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

multiCondition

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

Returns:

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.

push

public final PushMessageActivity push()

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

Returns:

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

randomSplit

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

Returns:

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.

sms

public final SMSMessageActivity sms()

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

Returns:

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

waitValue

public final WaitActivity waitValue()

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:

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.

toBuilder

public Activity.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Activity.Builder,Activity>

builder

public static Activity.Builder builder()

serializableBuilderClass

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