Struct aws_sdk_pinpoint::model::Schedule

#[non_exhaustive]
pub struct Schedule {
    pub end_time: Option<String>,
    pub event_filter: Option<CampaignEventFilter>,
    pub frequency: Option<Frequency>,
    pub is_local_time: bool,
    pub quiet_time: Option<QuietTime>,
    pub start_time: Option<String>,
    pub timezone: Option<String>,
}

Specifies the schedule settings for a campaign.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

end_time: Option<String>

The scheduled time, in ISO 8601 format, when the campaign ended or will end.

event_filter: Option<CampaignEventFilter>

The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

frequency: Option<Frequency>

Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

is_local_time: bool

Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

quiet_time: Option<QuietTime>

The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

• The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

• The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

• The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

start_time: Option<String>

The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

timezone: Option<String>

The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

Implementations

impl Schedule

pub fn end_time(&self) -> Option<&str>

The scheduled time, in ISO 8601 format, when the campaign ended or will end.

pub fn event_filter(&self) -> Option<&CampaignEventFilter>

The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

pub fn frequency(&self) -> Option<&Frequency>

Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

pub fn is_local_time(&self) -> bool

Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

pub fn quiet_time(&self) -> Option<&QuietTime>

The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

• The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

• The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

• The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

pub fn start_time(&self) -> Option<&str>

The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

pub fn timezone(&self) -> Option<&str>

The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

impl Schedule

pub fn builder() -> Builder

Creates a new builder-style object to manufacture Schedule

Trait Implementations

impl Clone for Schedule

fn clone(&self) -> Schedule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Schedule

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

Formats the value using the given formatter.

impl PartialEq<Schedule> for Schedule

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

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

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

This method tests for !=.

impl StructuralPartialEq for Schedule