com.amazonaws.services.pinpoint.model

Class WriteJourneyRequest

java.lang.Object

com.amazonaws.services.pinpoint.model.WriteJourneyRequest

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Specifies the configuration and other settings for a journey.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
WriteJourneyRequest()

Method Summary

Modifier and Type	Method and Description
WriteJourneyRequest	addActivitiesEntry(String key, Activity value)
WriteJourneyRequest	clearActivitiesEntries() Removes all the entries added into Activities.
WriteJourneyRequest	clone()
boolean	equals(Object obj)
Map<String,Activity>	getActivities() A map that contains a set of Activity objects, one object for each activity in the journey.
String	getCreationDate() The date, in ISO 8601 format, when the journey was created.
String	getLastModifiedDate() The date, in ISO 8601 format, when the journey was last modified.
JourneyLimits	getLimits() The messaging and entry limits for the journey.
Boolean	getLocalTime() Specifies whether the journey's scheduled start and end times use each participant's local time.
String	getName() The name of the journey.
QuietTime	getQuietTime() The quiet time settings for the journey.
String	getRefreshFrequency() The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
JourneySchedule	getSchedule() The schedule settings for the journey.
String	getStartActivity() The unique identifier for the first activity in the journey.
StartCondition	getStartCondition() The segment that defines which users are participants in the journey.
String	getState() The status of the journey.
int	hashCode()
Boolean	isLocalTime() Specifies whether the journey's scheduled start and end times use each participant's local time.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setActivities(Map<String,Activity> activities) A map that contains a set of Activity objects, one object for each activity in the journey.
void	setCreationDate(String creationDate) The date, in ISO 8601 format, when the journey was created.
void	setLastModifiedDate(String lastModifiedDate) The date, in ISO 8601 format, when the journey was last modified.
void	setLimits(JourneyLimits limits) The messaging and entry limits for the journey.
void	setLocalTime(Boolean localTime) Specifies whether the journey's scheduled start and end times use each participant's local time.
void	setName(String name) The name of the journey.
void	setQuietTime(QuietTime quietTime) The quiet time settings for the journey.
void	setRefreshFrequency(String refreshFrequency) The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
void	setSchedule(JourneySchedule schedule) The schedule settings for the journey.
void	setStartActivity(String startActivity) The unique identifier for the first activity in the journey.
void	setStartCondition(StartCondition startCondition) The segment that defines which users are participants in the journey.
void	setState(String state) The status of the journey.
String	toString() Returns a string representation of this object.
WriteJourneyRequest	withActivities(Map<String,Activity> activities) A map that contains a set of Activity objects, one object for each activity in the journey.
WriteJourneyRequest	withCreationDate(String creationDate) The date, in ISO 8601 format, when the journey was created.
WriteJourneyRequest	withLastModifiedDate(String lastModifiedDate) The date, in ISO 8601 format, when the journey was last modified.
WriteJourneyRequest	withLimits(JourneyLimits limits) The messaging and entry limits for the journey.
WriteJourneyRequest	withLocalTime(Boolean localTime) Specifies whether the journey's scheduled start and end times use each participant's local time.
WriteJourneyRequest	withName(String name) The name of the journey.
WriteJourneyRequest	withQuietTime(QuietTime quietTime) The quiet time settings for the journey.
WriteJourneyRequest	withRefreshFrequency(String refreshFrequency) The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
WriteJourneyRequest	withSchedule(JourneySchedule schedule) The schedule settings for the journey.
WriteJourneyRequest	withStartActivity(String startActivity) The unique identifier for the first activity in the journey.
WriteJourneyRequest	withStartCondition(StartCondition startCondition) The segment that defines which users are participants in the journey.
WriteJourneyRequest	withState(State state) The status of the journey.
WriteJourneyRequest	withState(String state) The status of the journey.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WriteJourneyRequest

public WriteJourneyRequest()

Method Detail

getActivities

public Map<String,Activity> getActivities()

A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 128 characters. The characters must be alphanumeric characters.

Returns:

A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 128 characters. The characters must be alphanumeric characters.

setActivities

public void setActivities(Map<String,Activity> activities)

A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 128 characters. The characters must be alphanumeric characters.

Parameters:

activities - A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 128 characters. The characters must be alphanumeric characters.

withActivities

public WriteJourneyRequest withActivities(Map<String,Activity> activities)

A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 128 characters. The characters must be alphanumeric characters.

Parameters:

activities - A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 128 characters. The characters must be alphanumeric characters.

Returns:

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

addActivitiesEntry

public WriteJourneyRequest addActivitiesEntry(String key,
                                              Activity value)

clearActivitiesEntries

public WriteJourneyRequest clearActivitiesEntries()

Removes all the entries added into Activities.

Returns:

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

setCreationDate

public void setCreationDate(String creationDate)

The date, in ISO 8601 format, when the journey was created.

Parameters:

creationDate - The date, in ISO 8601 format, when the journey was created.

getCreationDate

public String getCreationDate()

The date, in ISO 8601 format, when the journey was created.

Returns:

The date, in ISO 8601 format, when the journey was created.

withCreationDate

public WriteJourneyRequest withCreationDate(String creationDate)

The date, in ISO 8601 format, when the journey was created.

Parameters:

creationDate - The date, in ISO 8601 format, when the journey was created.

Returns:

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

setLastModifiedDate

public void setLastModifiedDate(String lastModifiedDate)

The date, in ISO 8601 format, when the journey was last modified.

Parameters:

lastModifiedDate - The date, in ISO 8601 format, when the journey was last modified.

getLastModifiedDate

public String getLastModifiedDate()

The date, in ISO 8601 format, when the journey was last modified.

Returns:

The date, in ISO 8601 format, when the journey was last modified.

withLastModifiedDate

public WriteJourneyRequest withLastModifiedDate(String lastModifiedDate)

The date, in ISO 8601 format, when the journey was last modified.

Parameters:

lastModifiedDate - The date, in ISO 8601 format, when the journey was last modified.

Returns:

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

setLimits

public void setLimits(JourneyLimits limits)

The messaging and entry limits for the journey.

Parameters:

limits - The messaging and entry limits for the journey.

getLimits

public JourneyLimits getLimits()

The messaging and entry limits for the journey.

Returns:

The messaging and entry limits for the journey.

withLimits

public WriteJourneyRequest withLimits(JourneyLimits limits)

The messaging and entry limits for the journey.

Parameters:

limits - The messaging and entry limits for the journey.

Returns:

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

setLocalTime

public void setLocalTime(Boolean localTime)

Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

Parameters:

localTime - Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

getLocalTime

public Boolean getLocalTime()

Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

Returns:

Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

withLocalTime

public WriteJourneyRequest withLocalTime(Boolean localTime)

Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

Parameters:

localTime - Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

Returns:

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

isLocalTime

public Boolean isLocalTime()

Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

Returns:

Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

setName

public void setName(String name)

The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.

Parameters:

name - The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.

getName

public String getName()

The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.

Returns:

The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.

withName

public WriteJourneyRequest withName(String name)

The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.

Parameters:

name - The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.

Returns:

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

setQuietTime

public void setQuietTime(QuietTime quietTime)

The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

• The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.

• The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.

• The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

Parameters:

quietTime - The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

• The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.

• The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.

• The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

getQuietTime

public QuietTime getQuietTime()

The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

• The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.

• The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.

• The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

Returns:

The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

• The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.

• The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.

• The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

withQuietTime

public WriteJourneyRequest withQuietTime(QuietTime quietTime)

The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

• The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.

• The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.

• The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

Parameters:

quietTime - The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

• The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.

• The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.

• The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

Returns:

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

setRefreshFrequency

public void setRefreshFrequency(String refreshFrequency)

The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

Parameters:

refreshFrequency - The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

getRefreshFrequency

public String getRefreshFrequency()

The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

Returns:

The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

withRefreshFrequency

public WriteJourneyRequest withRefreshFrequency(String refreshFrequency)

The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

Parameters:

refreshFrequency - The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

Returns:

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

setSchedule

public void setSchedule(JourneySchedule schedule)

The schedule settings for the journey.

Parameters:

schedule - The schedule settings for the journey.

getSchedule

public JourneySchedule getSchedule()

The schedule settings for the journey.

Returns:

The schedule settings for the journey.

withSchedule

public WriteJourneyRequest withSchedule(JourneySchedule schedule)

The schedule settings for the journey.

Parameters:

schedule - The schedule settings for the journey.

Returns:

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

setStartActivity

public void setStartActivity(String startActivity)

The unique identifier for the first activity in the journey. An activity identifier can contain a maximum of 128 characters. The characters must be alphanumeric characters.

Parameters:

startActivity - The unique identifier for the first activity in the journey. An activity identifier can contain a maximum of 128 characters. The characters must be alphanumeric characters.

getStartActivity

public String getStartActivity()

The unique identifier for the first activity in the journey. An activity identifier can contain a maximum of 128 characters. The characters must be alphanumeric characters.

Returns:

The unique identifier for the first activity in the journey. An activity identifier can contain a maximum of 128 characters. The characters must be alphanumeric characters.

withStartActivity

public WriteJourneyRequest withStartActivity(String startActivity)

The unique identifier for the first activity in the journey. An activity identifier can contain a maximum of 128 characters. The characters must be alphanumeric characters.

Parameters:

startActivity - The unique identifier for the first activity in the journey. An activity identifier can contain a maximum of 128 characters. The characters must be alphanumeric characters.

Returns:

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

setStartCondition

public void setStartCondition(StartCondition startCondition)

The segment that defines which users are participants in the journey.

Parameters:

startCondition - The segment that defines which users are participants in the journey.

getStartCondition

public StartCondition getStartCondition()

The segment that defines which users are participants in the journey.

Returns:

The segment that defines which users are participants in the journey.

withStartCondition

public WriteJourneyRequest withStartCondition(StartCondition startCondition)

The segment that defines which users are participants in the journey.

Parameters:

startCondition - The segment that defines which users are participants in the journey.

Returns:

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

setState

public void setState(String state)

The status of the journey. Valid values are:

• DRAFT - Saves the journey and doesn't publish it.

• ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey State resource.

Parameters:

state - The status of the journey. Valid values are:

• DRAFT - Saves the journey and doesn't publish it.

• ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey State resource.

See Also:

State

getState

public String getState()

The status of the journey. Valid values are:

• DRAFT - Saves the journey and doesn't publish it.

• ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey State resource.

Returns:

The status of the journey. Valid values are:

• DRAFT - Saves the journey and doesn't publish it.

• ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey State resource.

See Also:

State

withState

public WriteJourneyRequest withState(String state)

The status of the journey. Valid values are:

• DRAFT - Saves the journey and doesn't publish it.

• ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey State resource.

Parameters:

state - The status of the journey. Valid values are:

• DRAFT - Saves the journey and doesn't publish it.

• ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey State resource.

Returns:

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

See Also:

State

withState

public WriteJourneyRequest withState(State state)

The status of the journey. Valid values are:

• DRAFT - Saves the journey and doesn't publish it.

• ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey State resource.

Parameters:

state - The status of the journey. Valid values are:

• DRAFT - Saves the journey and doesn't publish it.

• ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey State resource.

Returns:

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

See Also:

State

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 WriteJourneyRequest clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.