Struct CanaryScheduleOutput 

#[non_exhaustive]
pub struct CanaryScheduleOutput {
    pub expression: Option<String>,
    pub duration_in_seconds: Option<i64>,
    pub retry_config: Option<RetryConfigOutput>,
}

How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.

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.

expression: Option<String>

A rate expression or a cron expression that defines how often the canary is to run.

For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour.

For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).

Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

Use cron(expression) to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron.

duration_in_seconds: Option<i64>

How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value.

retry_config: Option<RetryConfigOutput>

A structure that contains the retry configuration for a canary

Implementations

impl CanaryScheduleOutput

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

A rate expression or a cron expression that defines how often the canary is to run.

For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour.

For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).

Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

Use cron(expression) to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron.

pub fn duration_in_seconds(&self) -> Option<i64>

How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value.

pub fn retry_config(&self) -> Option<&RetryConfigOutput>

A structure that contains the retry configuration for a canary

impl CanaryScheduleOutput

pub fn builder() -> CanaryScheduleOutputBuilder

Creates a new builder-style object to manufacture CanaryScheduleOutput.

Trait Implementations

impl Clone for CanaryScheduleOutput

fn clone(&self) -> CanaryScheduleOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanaryScheduleOutput

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

Formats the value using the given formatter.

impl PartialEq for CanaryScheduleOutput

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

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

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 CanaryScheduleOutput