Struct aws_sdk_pinpoint::model::write_journey_request::Builder

#[non_exhaustive]
pub struct Builder { /* private fields */ }

A builder for WriteJourneyRequest

Implementations

impl Builder

pub fn activities(self, k: impl Into<String>, v: Activity) -> Self

Adds a key-value pair to activities.

To override the contents of this collection use set_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.

pub fn set_activities(self, input: Option<HashMap<String, Activity>>) -> Self

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.

pub fn creation_date(self, input: impl Into<String>) -> Self

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

pub fn set_creation_date(self, input: Option<String>) -> Self

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

pub fn last_modified_date(self, input: impl Into<String>) -> Self

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

pub fn set_last_modified_date(self, input: Option<String>) -> Self

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

pub fn limits(self, input: JourneyLimits) -> Self

The messaging and entry limits for the journey.

pub fn set_limits(self, input: Option<JourneyLimits>) -> Self

The messaging and entry limits for the journey.

pub fn local_time(self, input: bool) -> Self

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.

pub fn set_local_time(self, input: Option<bool>) -> Self

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.

pub fn name(self, input: impl Into<String>) -> Self

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.

pub fn set_name(self, input: Option<String>) -> Self

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.

pub fn quiet_time(self, input: QuietTime) -> Self

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.

pub fn set_quiet_time(self, input: Option<QuietTime>) -> Self

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.

pub fn refresh_frequency(self, input: impl Into<String>) -> Self

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

pub fn set_refresh_frequency(self, input: Option<String>) -> Self

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

pub fn schedule(self, input: JourneySchedule) -> Self

The schedule settings for the journey.

pub fn set_schedule(self, input: Option<JourneySchedule>) -> Self

The schedule settings for the journey.

pub fn start_activity(self, input: impl Into<String>) -> Self

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.

pub fn set_start_activity(self, input: Option<String>) -> Self

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.

pub fn start_condition(self, input: StartCondition) -> Self

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

pub fn set_start_condition(self, input: Option<StartCondition>) -> Self

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

pub fn state(self, input: State) -> Self

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.

pub fn set_state(self, input: Option<State>) -> Self

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.

pub fn wait_for_quiet_time(self, input: bool) -> Self

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

pub fn set_wait_for_quiet_time(self, input: Option<bool>) -> Self

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

pub fn refresh_on_segment_update(self, input: bool) -> Self

Specifies whether a journey should be refreshed on segment update.

pub fn set_refresh_on_segment_update(self, input: Option<bool>) -> Self

Specifies whether a journey should be refreshed on segment update.

pub fn journey_channel_settings(self, input: JourneyChannelSettings) -> Self

The channel-specific configurations for the journey.

pub fn set_journey_channel_settings(
    self,
    input: Option<JourneyChannelSettings>
) -> Self

The channel-specific configurations for the journey.

pub fn build(self) -> WriteJourneyRequest

Consumes the builder and constructs a WriteJourneyRequest

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Builder) -> bool

This method tests for !=.

impl StructuralPartialEq for Builder