Struct DeploymentComponentUpdatePolicy

#[non_exhaustive]
pub struct DeploymentComponentUpdatePolicy {
    pub timeout_in_seconds: Option<i32>,
    pub action: Option<DeploymentComponentUpdatePolicyAction>,
}

Contains information about a deployment's policy that defines when components are safe to update.

Each component on a device can report whether or not it's ready to update. After a component and its dependencies are ready, they can apply the update in the deployment. You can configure whether or not the deployment notifies components of an update and waits for a response. You specify the amount of time each component has to respond to the update notification.

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.

timeout_in_seconds: Option<i32>

The amount of time in seconds that each component on a device has to report that it's safe to update. If the component waits for longer than this timeout, then the deployment proceeds on the device.

Default: 60

action: Option<DeploymentComponentUpdatePolicyAction>

Whether or not to notify components and wait for components to become safe to update. Choose from the following options:

• NOTIFY_COMPONENTS – The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see Create deployments in the IoT Greengrass V2 Developer Guide.

• SKIP_NOTIFY_COMPONENTS – The deployment doesn't notify components or wait for them to be safe to update.

Default: NOTIFY_COMPONENTS

Implementations

impl DeploymentComponentUpdatePolicy

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

The amount of time in seconds that each component on a device has to report that it's safe to update. If the component waits for longer than this timeout, then the deployment proceeds on the device.

Default: 60

pub fn action(&self) -> Option<&DeploymentComponentUpdatePolicyAction>

Whether or not to notify components and wait for components to become safe to update. Choose from the following options:

• NOTIFY_COMPONENTS – The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see Create deployments in the IoT Greengrass V2 Developer Guide.

• SKIP_NOTIFY_COMPONENTS – The deployment doesn't notify components or wait for them to be safe to update.

Default: NOTIFY_COMPONENTS

impl DeploymentComponentUpdatePolicy

pub fn builder() -> DeploymentComponentUpdatePolicyBuilder

Creates a new builder-style object to manufacture DeploymentComponentUpdatePolicy.

Trait Implementations

impl Clone for DeploymentComponentUpdatePolicy

fn clone(&self) -> DeploymentComponentUpdatePolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeploymentComponentUpdatePolicy

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

Formats the value using the given formatter.

impl PartialEq for DeploymentComponentUpdatePolicy

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