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

Interface WriteJourneyRequest.Builder

    • Method Detail

      • activities

        WriteJourneyRequest.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. An activity identifier can contain a maximum of 100 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 100 characters. The characters must be alphanumeric characters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationDate

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

      • lastModifiedDate

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

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

      • localTime

        WriteJourneyRequest.Builder localTime​(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.

      • name

        WriteJourneyRequest.Builder name​(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.

      • quietTime

        WriteJourneyRequest.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 WriteJourneyRequest.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:
        quietTime(QuietTime)

      • refreshFrequency

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

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

      • startActivity

        WriteJourneyRequest.Builder startActivity​(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.

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

      • startCondition

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

      • state

        WriteJourneyRequest.Builder state​(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.

        PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume 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.

        PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume 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, State

      • state

        WriteJourneyRequest.Builder state​(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.

        PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume 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.

        PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume 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, State

      • waitForQuietTime

        WriteJourneyRequest.Builder waitForQuietTime​(Boolean waitForQuietTime)

        Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.

        Parameters:
        waitForQuietTime - Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • refreshOnSegmentUpdate

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

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

      • sendingSchedule

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

        WriteJourneyRequest.Builder openHours​(OpenHours openHours)

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

        Parameters:
        openHours - The time when journey allow to 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

        WriteJourneyRequest.Builder closedDays​(ClosedDays closedDays)

        The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.

        Parameters:
        closedDays - The time when journey will stop sending 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.

      • timezoneEstimationMethodsWithStrings

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

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

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

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