Struct RefreshScheduleFrequency

#[non_exhaustive]
pub struct RefreshScheduleFrequency {
    pub unit: Option<RefreshScheduleFrequencyUnit>,
    pub value: Option<i32>,
}

Specifies the frequency for a dashboard refresh schedule.

For a custom dashboard, you can schedule a refresh for every 1, 6, 12, or 24 hours, or every day.

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.

unit: Option<RefreshScheduleFrequencyUnit>

The unit to use for the refresh.

For custom dashboards, the unit can be HOURS or DAYS.

For the Highlights dashboard, the Unit must be HOURS.

value: Option<i32>

The value for the refresh schedule.

For custom dashboards, the following values are valid when the unit is HOURS: 1, 6, 12, 24

For custom dashboards, the only valid value when the unit is DAYS is 1.

For the Highlights dashboard, the Value must be 6.

Implementations

impl RefreshScheduleFrequency

pub fn unit(&self) -> Option<&RefreshScheduleFrequencyUnit>

The unit to use for the refresh.

For custom dashboards, the unit can be HOURS or DAYS.

For the Highlights dashboard, the Unit must be HOURS.

pub fn value(&self) -> Option<i32>

The value for the refresh schedule.

For custom dashboards, the following values are valid when the unit is HOURS: 1, 6, 12, 24

For custom dashboards, the only valid value when the unit is DAYS is 1.

For the Highlights dashboard, the Value must be 6.

impl RefreshScheduleFrequency

pub fn builder() -> RefreshScheduleFrequencyBuilder

Creates a new builder-style object to manufacture RefreshScheduleFrequency.

Trait Implementations

impl Clone for RefreshScheduleFrequency

fn clone(&self) -> RefreshScheduleFrequency

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RefreshScheduleFrequency

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

Formats the value using the given formatter.

impl PartialEq for RefreshScheduleFrequency

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RefreshScheduleFrequency