Class CoreDevice

java.lang.Object
software.amazon.awssdk.services.greengrassv2.model.CoreDevice
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CoreDevice.Builder,CoreDevice>
@Generated("software.amazon.awssdk:codegen") public final class CoreDevice extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CoreDevice.Builder,CoreDevice>

Contains information about a Greengrass core device, which is an IoT thing that runs the IoT Greengrass Core software.

See Also:

  • Method Details

    • coreDeviceThingName

      public final String coreDeviceThingName()

      The name of the core device. This is also the name of the IoT thing.

      Returns:
      The name of the core device. This is also the name of the IoT thing.

    • status

      public final CoreDeviceStatus status()

      The status of the core device. Core devices can have the following statuses:

      • HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.

      • UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.

      If the service returns an enum value that is not available in the current SDK version, status will return CoreDeviceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the core device. Core devices can have the following statuses:

      • HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.

      • UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the core device. Core devices can have the following statuses:

      • HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.

      • UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.

      If the service returns an enum value that is not available in the current SDK version, status will return CoreDeviceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the core device. Core devices can have the following statuses:

      • HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.

      • UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.

      See Also:

    • lastStatusUpdateTimestamp

      public final Instant lastStatusUpdateTimestamp()

      The time at which the core device's status last updated, expressed in ISO 8601 format.

      Returns:
      The time at which the core device's status last updated, expressed in ISO 8601 format.

    • platform

      public final String platform()

      The operating system platform that the core device runs.

      Returns:
      The operating system platform that the core device runs.

    • architecture

      public final String architecture()

      The computer architecture of the core device.

      Returns:
      The computer architecture of the core device.

    • runtime

      public final String runtime()

      The runtime for the core device. The runtime can be:

      • aws_nucleus_classic

      • aws_nucleus_lite

      Returns:
      The runtime for the core device. The runtime can be:

      • aws_nucleus_classic

      • aws_nucleus_lite

    • toBuilder

      public CoreDevice.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CoreDevice.Builder,CoreDevice>
      Returns:
      a builder for type T

    • builder

      public static CoreDevice.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CoreDevice.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.