Package software.amazon.awssdk.services.pinpoint.model

Interface JourneyResponse.Builder

All Superinterfaces:
Buildable, CopyableBuilder<JourneyResponse.Builder,JourneyResponse>, SdkBuilder<JourneyResponse.Builder,JourneyResponse>, SdkPojo
Enclosing class:
JourneyResponse
public static interface JourneyResponse.Builder extends SdkPojo, CopyableBuilder<JourneyResponse.Builder,JourneyResponse>

  • Method Details

    • activities

      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.

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applicationId

      JourneyResponse.Builder applicationId(String applicationId)

      The unique identifier for the application that the journey applies to.

      Parameters:
      applicationId - The unique identifier for the application that the journey applies to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationDate

      JourneyResponse.Builder creationDate(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.

    • id

      JourneyResponse.Builder id(String id)

      The unique identifier for the journey.

      Parameters:
      id - The unique identifier for the journey.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModifiedDate

      JourneyResponse.Builder lastModifiedDate(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.

    • limits

      JourneyResponse.Builder limits(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.

    • limits

      default JourneyResponse.Builder limits(Consumer<JourneyLimits.Builder> limits)

      The messaging and entry limits for the journey.

      This is a convenience method that creates an instance of the JourneyLimits.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).

      Parameters:
      limits - a consumer that will call methods on JourneyLimits.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • localTime

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      JourneyResponse.Builder name(String name)

      The name of the journey.

      Parameters:
      name - The name of the journey.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • quietTime

      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.

      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.

    • quietTime

      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 method that creates an instance of the QuietTime.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).

      Parameters:
      quietTime - a consumer that will call methods on QuietTime.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • refreshFrequency

      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.

      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.

    • schedule

      JourneyResponse.Builder schedule(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.

    • schedule

      default JourneyResponse.Builder schedule(Consumer<JourneySchedule.Builder> schedule)

      The schedule settings for the journey.

      This is a convenience method that creates an instance of the JourneySchedule.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).

      Parameters:
      schedule - a consumer that will call methods on JourneySchedule.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • startActivity

      JourneyResponse.Builder startActivity(String startActivity)

      The unique identifier for the first activity in the journey.

      Parameters:
      startActivity - The unique identifier for the first activity in the journey.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startCondition

      JourneyResponse.Builder startCondition(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.

    • startCondition

      default JourneyResponse.Builder startCondition(Consumer<StartCondition.Builder> startCondition)

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

      This is a convenience method that creates an instance of the StartCondition.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).

      Parameters:
      startCondition - a consumer that will call methods on StartCondition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      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.

      Parameters:
      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.

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

    • 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.

      Parameters:
      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.

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

    • tags

      JourneyResponse.Builder tags(Map<String,String> tags)

      This object is not used or supported.

      Parameters:
      tags - This object is not used or supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • waitForQuietTime

      JourneyResponse.Builder waitForQuietTime(Boolean waitForQuietTime)

      Indicates whether endpoints in quiet hours should enter a wait activity until quiet hours have elapsed.

      Parameters:
      waitForQuietTime - Indicates whether endpoints in quiet hours should enter a wait activity until quiet hours have elapsed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • refreshOnSegmentUpdate

      JourneyResponse.Builder refreshOnSegmentUpdate(Boolean refreshOnSegmentUpdate)

      Indicates whether the journey participants should be refreshed when a segment is updated.

      Parameters:
      refreshOnSegmentUpdate - Indicates whether the journey participants should be refreshed when a segment is updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • journeyChannelSettings

      JourneyResponse.Builder journeyChannelSettings(JourneyChannelSettings journeyChannelSettings)

      The channel-specific configurations for the journey.

      Parameters:
      journeyChannelSettings - The channel-specific configurations for the journey.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • journeyChannelSettings

      default JourneyResponse.Builder journeyChannelSettings(Consumer<JourneyChannelSettings.Builder> journeyChannelSettings)

      The channel-specific configurations for the journey.

      This is a convenience method that creates an instance of the JourneyChannelSettings.Builder avoiding the need to create one manually via JourneyChannelSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to journeyChannelSettings(JourneyChannelSettings).

      Parameters:
      journeyChannelSettings - a consumer that will call methods on JourneyChannelSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sendingSchedule

      JourneyResponse.Builder sendingSchedule(Boolean sendingSchedule)

      Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.

      Parameters:
      sendingSchedule - Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • openHours

      JourneyResponse.Builder openHours(OpenHours openHours)

      The time when a journey can send messages. QuietTime should be configured first and SendingSchedule should be set to true.

      Parameters:
      openHours - The time when a journey can send messages. QuietTime should be configured first and SendingSchedule should be set to true.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • openHours

      default JourneyResponse.Builder openHours(Consumer<OpenHours.Builder> openHours)

      The time when a journey can send messages. QuietTime should be configured first and SendingSchedule should be set to true.

      This is a convenience method that creates an instance of the OpenHours.Builder avoiding the need to create one manually via OpenHours.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to openHours(OpenHours).

      Parameters:
      openHours - a consumer that will call methods on OpenHours.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • closedDays

      JourneyResponse.Builder closedDays(ClosedDays closedDays)

      The time when a journey will not send messages. QuietTime should be configured first and SendingSchedule should be set to true.

      Parameters:
      closedDays - The time when a journey will not send messages. QuietTime should be configured first and SendingSchedule should be set to true.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • closedDays

      default JourneyResponse.Builder closedDays(Consumer<ClosedDays.Builder> closedDays)

      The time when a journey will not send messages. QuietTime should be configured first and SendingSchedule should be set to true.

      This is a convenience method that creates an instance of the ClosedDays.Builder avoiding the need to create one manually via ClosedDays.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to closedDays(ClosedDays).

      Parameters:
      closedDays - a consumer that will call methods on ClosedDays.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timezoneEstimationMethodsWithStrings

      JourneyResponse.Builder timezoneEstimationMethodsWithStrings(Collection<String> timezoneEstimationMethods)

      An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.

      • PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.

      • POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.

        POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.

      Parameters:
      timezoneEstimationMethods - An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.

      • PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.

      • POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.

        POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.

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

    • timezoneEstimationMethodsWithStrings

      JourneyResponse.Builder timezoneEstimationMethodsWithStrings(String... timezoneEstimationMethods)

      An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.

      • PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.

      • POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.

        POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.

      Parameters:
      timezoneEstimationMethods - An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.

      • PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.

      • POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.

        POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.

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

    • timezoneEstimationMethods

      JourneyResponse.Builder timezoneEstimationMethods(Collection<__TimezoneEstimationMethodsElement> timezoneEstimationMethods)

      An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.

      • PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.

      • POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.

        POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.

      Parameters:
      timezoneEstimationMethods - An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.

      • PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.

      • POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.

        POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.

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

    • timezoneEstimationMethods

      JourneyResponse.Builder timezoneEstimationMethods(__TimezoneEstimationMethodsElement... timezoneEstimationMethods)

      An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.

      • PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.

      • POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.

        POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.

      Parameters:
      timezoneEstimationMethods - An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.

      • PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.

      • POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.

        POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.

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