Struct ReportSchedule

pub struct ReportSchedule {
    pub active: Option<bool>,
    pub every: Option<i32>,
    pub expiration_date: Option<NaiveDate>,
    pub repeats: Option<String>,
    pub repeats_on_week_days: Option<Vec<String>>,
    pub runs_on_day_of_month: Option<String>,
    pub start_date: Option<NaiveDate>,
}

The report’s schedule. Can only be set if the report’s ‘dateRange’ is a relative date range and the relative date range is not “TODAY”.

This type is not used in any activity, and only used as part of another schema.

Fields

active: Option<bool>

Whether the schedule is active or not. Must be set to either true or false.

every: Option<i32>

Defines every how many days, weeks or months the report should be run. Needs to be set when “repeats” is either “DAILY”, “WEEKLY” or “MONTHLY”.

expiration_date: Option<NaiveDate>

The expiration date when the scheduled report stops running.

repeats: Option<String>

The interval for which the report is repeated. Note:

• “DAILY” also requires field “every” to be set.
• “WEEKLY” also requires fields “every” and “repeatsOnWeekDays” to be set.
• “MONTHLY” also requires fields “every” and “runsOnDayOfMonth” to be set.

repeats_on_week_days: Option<Vec<String>>

List of week days “WEEKLY” on which scheduled reports should run.

runs_on_day_of_month: Option<String>

Enum to define for “MONTHLY” scheduled reports whether reports should be repeated on the same day of the month as “startDate” or the same day of the week of the month. Example: If ‘startDate’ is Monday, April 2nd 2012 (2012-04-02), “DAY_OF_MONTH” would run subsequent reports on the 2nd of every Month, and “WEEK_OF_MONTH” would run subsequent reports on the first Monday of the month.

start_date: Option<NaiveDate>

Start date of date range for which scheduled reports should be run.

Trait Implementations

impl Clone for ReportSchedule

fn clone(&self) -> ReportSchedule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReportSchedule

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

Formats the value using the given formatter.

impl Default for ReportSchedule

fn default() -> ReportSchedule

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReportSchedule

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ReportSchedule

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl NestedType for ReportSchedule

impl Part for ReportSchedule