com.amazonaws.services.pinpoint.model

Class Activity

java.lang.Object

com.amazonaws.services.pinpoint.model.Activity

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Activity
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Activity()

Method Summary

Modifier and Type	Method and Description
Activity	clone()
boolean	equals(Object obj)
ConditionalSplitActivity	getConditionalSplit() The settings for a yes/no split activity.
CustomMessageActivity	getCUSTOM() The settings for a custom message activity.
String	getDescription() The custom description of the activity.
EmailMessageActivity	getEMAIL() The settings for an email activity.
HoldoutActivity	getHoldout() The settings for a holdout activity.
MultiConditionalSplitActivity	getMultiCondition() The settings for a multivariate split activity.
PushMessageActivity	getPUSH() The settings for a push notification activity.
RandomSplitActivity	getRandomSplit() The settings for a random split activity.
SMSMessageActivity	getSMS() The settings for an SMS activity.
WaitActivity	getWait() The settings for a wait activity.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setConditionalSplit(ConditionalSplitActivity conditionalSplit) The settings for a yes/no split activity.
void	setCUSTOM(CustomMessageActivity cUSTOM) The settings for a custom message activity.
void	setDescription(String description) The custom description of the activity.
void	setEMAIL(EmailMessageActivity eMAIL) The settings for an email activity.
void	setHoldout(HoldoutActivity holdout) The settings for a holdout activity.
void	setMultiCondition(MultiConditionalSplitActivity multiCondition) The settings for a multivariate split activity.
void	setPUSH(PushMessageActivity pUSH) The settings for a push notification activity.
void	setRandomSplit(RandomSplitActivity randomSplit) The settings for a random split activity.
void	setSMS(SMSMessageActivity sMS) The settings for an SMS activity.
void	setWait(WaitActivity wait) The settings for a wait activity.
String	toString() Returns a string representation of this object.
Activity	withConditionalSplit(ConditionalSplitActivity conditionalSplit) The settings for a yes/no split activity.
Activity	withCUSTOM(CustomMessageActivity cUSTOM) The settings for a custom message activity.
Activity	withDescription(String description) The custom description of the activity.
Activity	withEMAIL(EmailMessageActivity eMAIL) The settings for an email activity.
Activity	withHoldout(HoldoutActivity holdout) The settings for a holdout activity.
Activity	withMultiCondition(MultiConditionalSplitActivity multiCondition) The settings for a multivariate split activity.
Activity	withPUSH(PushMessageActivity pUSH) The settings for a push notification activity.
Activity	withRandomSplit(RandomSplitActivity randomSplit) The settings for a random split activity.
Activity	withSMS(SMSMessageActivity sMS) The settings for an SMS activity.
Activity	withWait(WaitActivity wait) The settings for a wait activity.

Methods inherited from class java.lang.Object

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

Constructor Detail

Activity

public Activity()

Method Detail

setCUSTOM

public void setCUSTOM(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.

getCUSTOM

public CustomMessageActivity getCUSTOM()

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.

withCUSTOM

public Activity withCUSTOM(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.

setConditionalSplit

public void setConditionalSplit(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.

getConditionalSplit

public ConditionalSplitActivity getConditionalSplit()

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.

withConditionalSplit

public Activity withConditionalSplit(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.

setDescription

public void setDescription(String description)

The custom description of the activity.

Parameters:

description - The custom description of the activity.

getDescription

public String getDescription()

The custom description of the activity.

Returns:

The custom description of the activity.

withDescription

public Activity withDescription(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.

setEMAIL

public void setEMAIL(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.

getEMAIL

public EmailMessageActivity getEMAIL()

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.

withEMAIL

public Activity withEMAIL(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.

setHoldout

public void setHoldout(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.

getHoldout

public HoldoutActivity getHoldout()

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.

withHoldout

public Activity withHoldout(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.

setMultiCondition

public void setMultiCondition(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.

getMultiCondition

public MultiConditionalSplitActivity getMultiCondition()

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.

withMultiCondition

public Activity withMultiCondition(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.

setPUSH

public void setPUSH(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.

getPUSH

public PushMessageActivity getPUSH()

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.

withPUSH

public Activity withPUSH(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.

setRandomSplit

public void setRandomSplit(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.

getRandomSplit

public RandomSplitActivity getRandomSplit()

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.

withRandomSplit

public Activity withRandomSplit(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.

setSMS

public void setSMS(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.

getSMS

public SMSMessageActivity getSMS()

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.

withSMS

public Activity withSMS(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.

setWait

public void setWait(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.

getWait

public WaitActivity getWait()

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.

withWait

public Activity withWait(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Activity clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo