InstalledComponent (AWS Java SDK :: Services :: Greengrass V2 2.20.128 API)

java.lang.Object
- software.amazon.awssdk.services.greengrassv2.model.InstalledComponent

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<InstalledComponent.Builder,InstalledComponent>

@Generated(value="software.amazon.awssdk:codegen")
public final class InstalledComponent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InstalledComponent.Builder,InstalledComponent>

Contains information about a component on a Greengrass core device.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface InstalledComponent.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`InstalledComponent.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static InstalledComponent.Builder`	`builder()`
`String`	`componentName()` The name of the component.
`String`	`componentVersion()` The version of the component.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLifecycleStatusCodes()` For responses, this returns true if the service returned a value for the LifecycleStatusCodes property.
`Boolean`	`isRoot()` Whether or not the component is a root component.
`String`	`lastInstallationSource()` The most recent deployment source that brought the component to the Greengrass core device.
`Instant`	`lastReportedTimestamp()` The last time the Greengrass core device sent a message containing a component's state to the Amazon Web Services Cloud.
`Instant`	`lastStatusChangeTimestamp()` The status of how current the data is.
`InstalledComponentLifecycleState`	`lifecycleState()` The lifecycle state of the component.
`String`	`lifecycleStateAsString()` The lifecycle state of the component.
`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.
`List<String>`	`lifecycleStatusCodes()` The status codes that indicate the reason for failure whenever the `lifecycleState` has an error or is in a broken state.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends InstalledComponent.Builder>`	`serializableBuilderClass()`
`InstalledComponent.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - componentName
```
public final String componentName()
```
    The name of the component.
    
    Returns:
    
    The name of the component.
  - componentVersion
```
public final String componentVersion()
```
    The version of the component.
    
    Returns:
    
    The version of the component.
  - lifecycleState
```
public final InstalledComponentLifecycleState lifecycleState()
```
    The lifecycle state of the component.
    
    If the service returns an enum value that is not available in the current SDK version, lifecycleState will return InstalledComponentLifecycleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleStateAsString().
    
    Returns:
    
    The lifecycle state of the component.
    
    See Also:
    
    InstalledComponentLifecycleState
  - lifecycleStateAsString
```
public final String lifecycleStateAsString()
```
    The lifecycle state of the component.
    
    If the service returns an enum value that is not available in the current SDK version, lifecycleState will return InstalledComponentLifecycleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleStateAsString().
    
    Returns:
    
    The lifecycle state of the component.
    
    See Also:
    
    InstalledComponentLifecycleState
  - lifecycleStateDetails
```
public final 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.
    
    Returns:
    
    A detailed response about the lifecycle state of the component that explains the reason why a component has an error or is broken.
  - isRoot
```
public final Boolean isRoot()
```
    Whether or not the component is a root component.
    
    Returns:
    
    Whether or not the component is a root component.
  - lastStatusChangeTimestamp
```
public final 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.
    
    Returns:
    
    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.
  - lastReportedTimestamp
```
public final 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.
    
    Returns:
    
    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.
  - lastInstallationSource
```
public final 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.
    
    Returns:
    
    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.
  - hasLifecycleStatusCodes
```
public final boolean hasLifecycleStatusCodes()
```
    For responses, this returns true if the service returned a value for the LifecycleStatusCodes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - lifecycleStatusCodes
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLifecycleStatusCodes() method.
    
    Returns:
    
    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.
  - toBuilder
```
public InstalledComponent.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InstalledComponent.Builder,InstalledComponent>
  - builder
```
public static InstalledComponent.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends InstalledComponent.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class InstalledComponent

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

componentName

componentVersion

lifecycleState

lifecycleStateAsString

lifecycleStateDetails

isRoot

lastStatusChangeTimestamp

lastReportedTimestamp

lastInstallationSource

hasLifecycleStatusCodes

lifecycleStatusCodes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields