software.amazon.awssdk.services.greengrassv2.model

Class GetCoreDeviceResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.greengrassv2.model.GreengrassV2Response

software.amazon.awssdk.services.greengrassv2.model.GetCoreDeviceResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetCoreDeviceResponse.Builder,GetCoreDeviceResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetCoreDeviceResponse
extends GreengrassV2Response
implements ToCopyableBuilder<GetCoreDeviceResponse.Builder,GetCoreDeviceResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetCoreDeviceResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	architecture() The computer architecture of the core device.
static GetCoreDeviceResponse.Builder	builder()
String	coreDeviceThingName() The name of the core device.
String	coreVersion() The version of the IoT Greengrass Core software that the core device runs.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
Instant	lastStatusUpdateTimestamp() The time at which the core device's status last updated, expressed in ISO 8601 format.
String	platform() The operating system platform that the core device runs.
List<SdkField<?>>	sdkFields()
static Class<? extends GetCoreDeviceResponse.Builder>	serializableBuilderClass()
CoreDeviceStatus	status() The status of the core device.
String	statusAsString() The status of the core device.
Map<String,String>	tags() A list of key-value pairs that contain metadata for the resource.
GetCoreDeviceResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.greengrassv2.model.GreengrassV2Response

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

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.

coreVersion

public final String coreVersion()

The version of the IoT Greengrass Core software that the core device runs. This version is equivalent to the version of the Greengrass nucleus component that runs on the core device. For more information, see the Greengrass nucleus component in the IoT Greengrass V2 Developer Guide.

Returns:

The version of the IoT Greengrass Core software that the core device runs. This version is equivalent to the version of the Greengrass nucleus component that runs on the core device. For more information, see the Greengrass nucleus component in the IoT Greengrass V2 Developer Guide.

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.

status

public final CoreDeviceStatus status()

The status of the core device. The core device status can be:

• 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. The core device status can be:

• 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:

CoreDeviceStatus

statusAsString

public final String statusAsString()

The status of the core device. The core device status can be:

• 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. The core device status can be:

• 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:

CoreDeviceStatus

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final Map<String,String> tags()

A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.

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 hasTags() method.

Returns:

A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.

toBuilder

public GetCoreDeviceResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetCoreDeviceResponse.Builder,GetCoreDeviceResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetCoreDeviceResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetCoreDeviceResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo