software.amazon.awssdk.services.pinpoint.model

Class WriteJourneyRequest

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.WriteJourneyRequest

All Implemented Interfaces:

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

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

Specifies the configuration and other settings for a journey.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WriteJourneyRequest.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,Activity>	activities() A map that contains a set of Activity objects, one object for each activity in the journey.
static WriteJourneyRequest.Builder	builder()
String	creationDate() The date, in ISO 8601 format, when the journey was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasActivities() Returns true if the Activities property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	lastModifiedDate() The date, in ISO 8601 format, when the journey was last modified.
JourneyLimits	limits() The messaging and entry limits for the journey.
Boolean	localTime() Specifies whether the journey's scheduled start and end times use each participant's local time.
String	name() The name of the journey.
QuietTime	quietTime() The quiet time settings for the journey.
String	refreshFrequency() The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
JourneySchedule	schedule() The schedule settings for the journey.
List<SdkField<?>>	sdkFields()
static Class<? extends WriteJourneyRequest.Builder>	serializableBuilderClass()
String	startActivity() The unique identifier for the first activity in the journey.
StartCondition	startCondition() The segment that defines which users are participants in the journey.
State	state() The status of the journey.
String	stateAsString() The status of the journey.
WriteJourneyRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

hasActivities

public final boolean hasActivities()

Returns true if the Activities property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

activities

public final 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 100 characters. The characters must be alphanumeric characters.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasActivities() to see if a value was sent in this field.

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 100 characters. The characters must be alphanumeric characters.

creationDate

public final String creationDate()

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

Returns:

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

lastModifiedDate

public final String lastModifiedDate()

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.

limits

public final JourneyLimits limits()

The messaging and entry limits for the journey.

Returns:

The messaging and entry limits for the journey.

localTime

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

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.

name

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

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.

quietTime

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

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.

refreshFrequency

public final String refreshFrequency()

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.

schedule

public final JourneySchedule schedule()

The schedule settings for the journey.

Returns:

The schedule settings for the journey.

startActivity

public final String startActivity()

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

Returns:

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

startCondition

public final StartCondition startCondition()

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

Returns:

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

state

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

If the service returns an enum value that is not available in the current SDK version, state will return State.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

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

stateAsString

public final String stateAsString()

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.

If the service returns an enum value that is not available in the current SDK version, state will return State.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

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

toBuilder

public WriteJourneyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WriteJourneyRequest.Builder,WriteJourneyRequest>

builder

public static WriteJourneyRequest.Builder builder()

serializableBuilderClass

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