Struct CanaryScheduleOutputBuilder 

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

A builder for CanaryScheduleOutput.

Implementations

impl CanaryScheduleOutputBuilder

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

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 set_expression(self, input: Option<String>) -> Self

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 get_expression(&self) -> &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.

pub fn duration_in_seconds(self, input: i64) -> Self

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 set_duration_in_seconds(self, input: Option<i64>) -> Self

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 get_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, input: RetryConfigOutput) -> Self

A structure that contains the retry configuration for a canary

pub fn set_retry_config(self, input: Option<RetryConfigOutput>) -> Self

A structure that contains the retry configuration for a canary

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

A structure that contains the retry configuration for a canary

pub fn build(self) -> CanaryScheduleOutput

Consumes the builder and constructs a CanaryScheduleOutput.

Trait Implementations

impl Clone for CanaryScheduleOutputBuilder

fn clone(&self) -> CanaryScheduleOutputBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanaryScheduleOutputBuilder

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

Formats the value using the given formatter.

impl Default for CanaryScheduleOutputBuilder

fn default() -> CanaryScheduleOutputBuilder

Returns the “default value” for a type.

impl PartialEq for CanaryScheduleOutputBuilder

fn eq(&self, other: &CanaryScheduleOutputBuilder) -> 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 CanaryScheduleOutputBuilder