Struct CanaryScheduleInputBuilder 

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

A builder for CanaryScheduleInput.

Implementations

impl CanaryScheduleInputBuilder

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. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see Scheduling canary runs using cron.

This field is required.

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. You can't schedule a canary to wait for more than a year before running. 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. You can't schedule a canary to wait for more than a year before running. 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 according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.

pub fn set_duration_in_seconds(self, input: Option<i64>) -> Self

How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.

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

How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.

pub fn retry_config(self, input: RetryConfigInput) -> Self

A structure that contains the retry configuration for a canary

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

A structure that contains the retry configuration for a canary

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

A structure that contains the retry configuration for a canary

pub fn build(self) -> Result<CanaryScheduleInput, BuildError>

Consumes the builder and constructs a CanaryScheduleInput. This method will fail if any of the following fields are not set:

• expression

Trait Implementations

impl Clone for CanaryScheduleInputBuilder

fn clone(&self) -> CanaryScheduleInputBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanaryScheduleInputBuilder

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

Formats the value using the given formatter.

impl Default for CanaryScheduleInputBuilder

fn default() -> CanaryScheduleInputBuilder

Returns the “default value” for a type.

impl PartialEq for CanaryScheduleInputBuilder

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