Struct ExponentialRolloutRate

#[non_exhaustive]
pub struct ExponentialRolloutRate {
    pub base_rate_per_minute: i32,
    pub increment_factor: f64,
    pub rate_increase_criteria: Option<RateIncreaseCriteria>,
}

Allows you to create an exponential rate of rollout for a job.

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.

base_rate_per_minute: i32

The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

increment_factor: f64

The exponential factor to increase the rate of rollout for a job.

Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

rate_increase_criteria: Option<RateIncreaseCriteria>

The criteria to initiate the increase in rate of rollout for a job.

Implementations

impl ExponentialRolloutRate

pub fn base_rate_per_minute(&self) -> i32

The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

pub fn increment_factor(&self) -> f64

The exponential factor to increase the rate of rollout for a job.

Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

pub fn rate_increase_criteria(&self) -> Option<&RateIncreaseCriteria>

The criteria to initiate the increase in rate of rollout for a job.

impl ExponentialRolloutRate

pub fn builder() -> ExponentialRolloutRateBuilder

Creates a new builder-style object to manufacture ExponentialRolloutRate.

Trait Implementations

impl Clone for ExponentialRolloutRate

fn clone(&self) -> ExponentialRolloutRate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExponentialRolloutRate

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

Formats the value using the given formatter.

impl PartialEq for ExponentialRolloutRate

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