Struct CloudComponentStatus

#[non_exhaustive]
pub struct CloudComponentStatus {
    pub component_state: Option<CloudComponentState>,
    pub message: Option<String>,
    pub errors: Option<HashMap<String, String>>,
    pub vendor_guidance: Option<VendorGuidance>,
    pub vendor_guidance_message: Option<String>,
}

Contains the status of a component version in the IoT Greengrass service.

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.

component_state: Option<CloudComponentState>

The state of the component version.

message: Option<String>

A message that communicates details, such as errors, about the status of the component version.

errors: Option<HashMap<String, String>>

A dictionary of errors that communicate why the component version is in an error state. For example, if IoT Greengrass can't access an artifact for the component version, then errors contains the artifact's URI as a key, and the error message as the value for that key.

vendor_guidance: Option<VendorGuidance>

The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:

• ACTIVE – This component version is available and recommended for use.

• DISCONTINUED – This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.

• DELETED – This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.

vendor_guidance_message: Option<String>

A message that communicates details about the vendor guidance state of the component version. This message communicates why a component version is discontinued or deleted.

Implementations

impl CloudComponentStatus

pub fn component_state(&self) -> Option<&CloudComponentState>

The state of the component version.

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

A message that communicates details, such as errors, about the status of the component version.

pub fn errors(&self) -> Option<&HashMap<String, String>>

A dictionary of errors that communicate why the component version is in an error state. For example, if IoT Greengrass can't access an artifact for the component version, then errors contains the artifact's URI as a key, and the error message as the value for that key.

pub fn vendor_guidance(&self) -> Option<&VendorGuidance>

The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:

• ACTIVE – This component version is available and recommended for use.

• DISCONTINUED – This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.

• DELETED – This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.

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

A message that communicates details about the vendor guidance state of the component version. This message communicates why a component version is discontinued or deleted.

impl CloudComponentStatus

pub fn builder() -> CloudComponentStatusBuilder

Creates a new builder-style object to manufacture CloudComponentStatus.

Trait Implementations

impl Clone for CloudComponentStatus

fn clone(&self) -> CloudComponentStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CloudComponentStatus

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

Formats the value using the given formatter.

impl PartialEq for CloudComponentStatus

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