Struct aws_sdk_greengrassv2::types::InstalledComponent

#[non_exhaustive]
pub struct InstalledComponent {
    pub component_name: Option<String>,
    pub component_version: Option<String>,
    pub lifecycle_state: Option<InstalledComponentLifecycleState>,
    pub lifecycle_state_details: Option<String>,
    pub is_root: bool,
    pub last_status_change_timestamp: Option<DateTime>,
    pub last_reported_timestamp: Option<DateTime>,
    pub last_installation_source: Option<String>,
    pub lifecycle_status_codes: Option<Vec<String>>,
}

Contains information about a component on a Greengrass core device.

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_name: Option<String>

The name of the component.

component_version: Option<String>

The version of the component.

lifecycle_state: Option<InstalledComponentLifecycleState>

The lifecycle state of the component.

lifecycle_state_details: Option<String>

A detailed response about the lifecycle state of the component that explains the reason why a component has an error or is broken.

is_root: bool

Whether or not the component is a root component.

last_status_change_timestamp: Option<DateTime>

The status of how current the data is.

This response is based off of component state changes. The status reflects component disruptions and deployments. If a component only sees a configuration update during a deployment, it might not undergo a state change and this status would not be updated.

last_reported_timestamp: Option<DateTime>

The last time the Greengrass core device sent a message containing a component's state to the Amazon Web Services Cloud.

A component does not need to see a state change for this field to update.

last_installation_source: Option<String>

The most recent deployment source that brought the component to the Greengrass core device. For a thing group deployment or thing deployment, the source will be the ID of the last deployment that contained the component. For local deployments it will be LOCAL.

Any deployment will attempt to reinstall currently broken components on the device, which will update the last installation source.

lifecycle_status_codes: Option<Vec<String>>

The status codes that indicate the reason for failure whenever the lifecycleState has an error or is in a broken state.

Greengrass nucleus v2.8.0 or later is required to get an accurate lifecycleStatusCodes response. This response can be inaccurate in earlier Greengrass nucleus versions.

Implementations

impl InstalledComponent

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

The name of the component.

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

The version of the component.

pub fn lifecycle_state(&self) -> Option<&InstalledComponentLifecycleState>

The lifecycle state of the component.

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

A detailed response about the lifecycle state of the component that explains the reason why a component has an error or is broken.

pub fn is_root(&self) -> bool

Whether or not the component is a root component.

pub fn last_status_change_timestamp(&self) -> Option<&DateTime>

The status of how current the data is.

This response is based off of component state changes. The status reflects component disruptions and deployments. If a component only sees a configuration update during a deployment, it might not undergo a state change and this status would not be updated.

pub fn last_reported_timestamp(&self) -> Option<&DateTime>

The last time the Greengrass core device sent a message containing a component's state to the Amazon Web Services Cloud.

A component does not need to see a state change for this field to update.

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

The most recent deployment source that brought the component to the Greengrass core device. For a thing group deployment or thing deployment, the source will be the ID of the last deployment that contained the component. For local deployments it will be LOCAL.

Any deployment will attempt to reinstall currently broken components on the device, which will update the last installation source.

pub fn lifecycle_status_codes(&self) -> &[String]

The status codes that indicate the reason for failure whenever the lifecycleState has an error or is in a broken state.

Greengrass nucleus v2.8.0 or later is required to get an accurate lifecycleStatusCodes response. This response can be inaccurate in earlier Greengrass nucleus versions.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .lifecycle_status_codes.is_none().

impl InstalledComponent

pub fn builder() -> InstalledComponentBuilder

Creates a new builder-style object to manufacture InstalledComponent.

Trait Implementations

impl Clone for InstalledComponent

fn clone(&self) -> InstalledComponent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstalledComponent

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

Formats the value using the given formatter.

impl PartialEq for InstalledComponent

fn eq(&self, other: &InstalledComponent) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for InstalledComponent