public static interface JourneyResponse.Builder extends SdkPojo, CopyableBuilder<JourneyResponse.Builder,JourneyResponse>
Modifier and Type | Method and Description |
---|---|
JourneyResponse.Builder |
activities(Map<String,Activity> activities)
A map that contains a set of Activity objects, one object for each activity in the journey.
|
JourneyResponse.Builder |
applicationId(String applicationId)
The unique identifier for the application that the journey applies to.
|
JourneyResponse.Builder |
creationDate(String creationDate)
The date, in ISO 8601 format, when the journey was created.
|
JourneyResponse.Builder |
id(String id)
The unique identifier for the journey.
|
JourneyResponse.Builder |
lastModifiedDate(String lastModifiedDate)
The date, in ISO 8601 format, when the journey was last modified.
|
default JourneyResponse.Builder |
limits(Consumer<JourneyLimits.Builder> limits)
The messaging and entry limits for the journey.
|
JourneyResponse.Builder |
limits(JourneyLimits limits)
The messaging and entry limits for the journey.
|
JourneyResponse.Builder |
localTime(Boolean localTime)
Specifies whether the journey's scheduled start and end times use each participant's local time.
|
JourneyResponse.Builder |
name(String name)
The name of the journey.
|
default JourneyResponse.Builder |
quietTime(Consumer<QuietTime.Builder> quietTime)
The quiet time settings for the journey.
|
JourneyResponse.Builder |
quietTime(QuietTime quietTime)
The quiet time settings for the journey.
|
JourneyResponse.Builder |
refreshFrequency(String refreshFrequency)
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in
ISO 8601 format.
|
default JourneyResponse.Builder |
schedule(Consumer<JourneySchedule.Builder> schedule)
The schedule settings for the journey.
|
JourneyResponse.Builder |
schedule(JourneySchedule schedule)
The schedule settings for the journey.
|
JourneyResponse.Builder |
startActivity(String startActivity)
The unique identifier for the first activity in the journey.
|
default JourneyResponse.Builder |
startCondition(Consumer<StartCondition.Builder> startCondition)
The segment that defines which users are participants in the journey.
|
JourneyResponse.Builder |
startCondition(StartCondition startCondition)
The segment that defines which users are participants in the journey.
|
JourneyResponse.Builder |
state(State state)
The current status of the journey.
|
JourneyResponse.Builder |
state(String state)
The current status of the journey.
|
JourneyResponse.Builder |
tags(Map<String,String> tags)
This object is not used or supported.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
JourneyResponse.Builder activities(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.
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.JourneyResponse.Builder applicationId(String applicationId)
The unique identifier for the application that the journey applies to.
applicationId
- The unique identifier for the application that the journey applies to.JourneyResponse.Builder creationDate(String creationDate)
The date, in ISO 8601 format, when the journey was created.
creationDate
- The date, in ISO 8601 format, when the journey was created.JourneyResponse.Builder id(String id)
The unique identifier for the journey.
id
- The unique identifier for the journey.JourneyResponse.Builder lastModifiedDate(String lastModifiedDate)
The date, in ISO 8601 format, when the journey was last modified.
lastModifiedDate
- The date, in ISO 8601 format, when the journey was last modified.JourneyResponse.Builder limits(JourneyLimits limits)
The messaging and entry limits for the journey.
limits
- The messaging and entry limits for the journey.default JourneyResponse.Builder limits(Consumer<JourneyLimits.Builder> limits)
The messaging and entry limits for the journey.
This is a convenience that creates an instance of theJourneyLimits.Builder
avoiding the need to
create one manually via JourneyLimits.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to limits(JourneyLimits)
.limits
- a consumer that will call methods on JourneyLimits.Builder
limits(JourneyLimits)
JourneyResponse.Builder localTime(Boolean localTime)
Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
localTime
- Specifies whether the journey's scheduled start and end times use each participant's local time. If
this value is true, the schedule uses each participant's local time.JourneyResponse.Builder name(String name)
The name of the journey.
name
- The name of the journey.JourneyResponse.Builder quietTime(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.
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.
default JourneyResponse.Builder quietTime(Consumer<QuietTime.Builder> 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.
This is a convenience that creates an instance of theQuietTime.Builder
avoiding the need to create
one manually via QuietTime.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result
is passed to quietTime(QuietTime)
.quietTime
- a consumer that will call methods on QuietTime.Builder
quietTime(QuietTime)
JourneyResponse.Builder refreshFrequency(String refreshFrequency)
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
refreshFrequency
- The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a
duration in ISO 8601 format.JourneyResponse.Builder schedule(JourneySchedule schedule)
The schedule settings for the journey.
schedule
- The schedule settings for the journey.default JourneyResponse.Builder schedule(Consumer<JourneySchedule.Builder> schedule)
The schedule settings for the journey.
This is a convenience that creates an instance of theJourneySchedule.Builder
avoiding the need to
create one manually via JourneySchedule.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to schedule(JourneySchedule)
.schedule
- a consumer that will call methods on JourneySchedule.Builder
schedule(JourneySchedule)
JourneyResponse.Builder startActivity(String startActivity)
The unique identifier for the first activity in the journey.
startActivity
- The unique identifier for the first activity in the journey.JourneyResponse.Builder startCondition(StartCondition startCondition)
The segment that defines which users are participants in the journey.
startCondition
- The segment that defines which users are participants in the journey.default JourneyResponse.Builder startCondition(Consumer<StartCondition.Builder> startCondition)
The segment that defines which users are participants in the journey.
This is a convenience that creates an instance of theStartCondition.Builder
avoiding the need to
create one manually via StartCondition.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to startCondition(StartCondition)
.startCondition
- a consumer that will call methods on StartCondition.Builder
startCondition(StartCondition)
JourneyResponse.Builder state(String state)
The current status of the journey. Possible values are:
DRAFT - The journey is being developed and hasn't been published yet.
ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
state
- The current status of the journey. Possible values are:
DRAFT - The journey is being developed and hasn't been published yet.
ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
State
,
State
JourneyResponse.Builder state(State state)
The current status of the journey. Possible values are:
DRAFT - The journey is being developed and hasn't been published yet.
ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
state
- The current status of the journey. Possible values are:
DRAFT - The journey is being developed and hasn't been published yet.
ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
State
,
State
JourneyResponse.Builder tags(Map<String,String> tags)
This object is not used or supported.
tags
- This object is not used or supported.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.