software.amazon.awssdk.services.greengrassv2.model

Interface InstalledComponent.Builder

All Superinterfaces:

Buildable, CopyableBuilder<InstalledComponent.Builder,InstalledComponent>, SdkBuilder<InstalledComponent.Builder,InstalledComponent>, SdkPojo

Enclosing class:

InstalledComponent

public static interface InstalledComponent.Builder
extends SdkPojo, CopyableBuilder<InstalledComponent.Builder,InstalledComponent>

Method Summary

Modifier and Type	Method and Description
InstalledComponent.Builder	componentName(String componentName) The name of the component.
InstalledComponent.Builder	componentVersion(String componentVersion) The version of the component.
InstalledComponent.Builder	isRoot(Boolean isRoot) Whether or not the component is a root component.
InstalledComponent.Builder	lastInstallationSource(String lastInstallationSource) The most recent deployment source that brought the component to the Greengrass core device.
InstalledComponent.Builder	lastReportedTimestamp(Instant lastReportedTimestamp) The last time the Greengrass core device sent a message containing a component's state to the Amazon Web Services Cloud.
InstalledComponent.Builder	lastStatusChangeTimestamp(Instant lastStatusChangeTimestamp) The status of how current the data is.
InstalledComponent.Builder	lifecycleState(InstalledComponentLifecycleState lifecycleState) The lifecycle state of the component.
InstalledComponent.Builder	lifecycleState(String lifecycleState) The lifecycle state of the component.
InstalledComponent.Builder	lifecycleStateDetails(String lifecycleStateDetails) A detailed response about the lifecycle state of the component that explains the reason why a component has an error or is broken.
InstalledComponent.Builder	lifecycleStatusCodes(Collection<String> lifecycleStatusCodes) The status codes that indicate the reason for failure whenever the lifecycleState has an error or is in a broken state.
InstalledComponent.Builder	lifecycleStatusCodes(String... lifecycleStatusCodes) The status codes that indicate the reason for failure whenever the lifecycleState has an error or is in a broken state.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

componentName

InstalledComponent.Builder componentName(String componentName)

The name of the component.

Parameters:

componentName - The name of the component.

Returns:

Returns a reference to this object so that method calls can be chained together.

componentVersion

InstalledComponent.Builder componentVersion(String componentVersion)

The version of the component.

Parameters:

componentVersion - The version of the component.

Returns:

Returns a reference to this object so that method calls can be chained together.

lifecycleState

InstalledComponent.Builder lifecycleState(String lifecycleState)

The lifecycle state of the component.

Parameters:

lifecycleState - The lifecycle state of the component.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InstalledComponentLifecycleState, InstalledComponentLifecycleState

lifecycleState

InstalledComponent.Builder lifecycleState(InstalledComponentLifecycleState lifecycleState)

The lifecycle state of the component.

Parameters:

lifecycleState - The lifecycle state of the component.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InstalledComponentLifecycleState, InstalledComponentLifecycleState

lifecycleStateDetails

InstalledComponent.Builder lifecycleStateDetails(String lifecycleStateDetails)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isRoot

InstalledComponent.Builder isRoot(Boolean isRoot)

Whether or not the component is a root component.

Parameters:

isRoot - Whether or not the component is a root component.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastStatusChangeTimestamp

InstalledComponent.Builder lastStatusChangeTimestamp(Instant lastStatusChangeTimestamp)

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.

Parameters:

lastStatusChangeTimestamp - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastReportedTimestamp

InstalledComponent.Builder lastReportedTimestamp(Instant lastReportedTimestamp)

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.

Parameters:

lastReportedTimestamp - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastInstallationSource

InstalledComponent.Builder lastInstallationSource(String lastInstallationSource)

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 The ID of the deployment. and 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.

Parameters:

lastInstallationSource - 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 The ID of the deployment. and 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

lifecycleStatusCodes

InstalledComponent.Builder lifecycleStatusCodes(Collection<String> lifecycleStatusCodes)

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.

Parameters:

lifecycleStatusCodes - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

lifecycleStatusCodes

InstalledComponent.Builder lifecycleStatusCodes(String... lifecycleStatusCodes)

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.

Parameters:

lifecycleStatusCodes - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.