Package software.amazon.awssdk.services.sagemaker.model

Class DeviceSummary

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.DeviceSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DeviceSummary.Builder,DeviceSummary>

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

Summary of the device.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeviceSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	agentVersion()	Edge Manager agent version.
static DeviceSummary.Builder	builder()
String	description()	A description of the device.
String	deviceArn()	Amazon Resource Name (ARN) of the device.
String	deviceFleetName()	The name of the fleet the device belongs to.
String	deviceName()	The unique identifier of the device.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasModels()	For responses, this returns true if the service returned a value for the Models property.
String	iotThingName()	The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..
Instant	latestHeartbeat()	The last heartbeat received from the device.
List<EdgeModelSummary>	models()	Models on the device.
Instant	registrationTime()	The timestamp of the last registration or de-reregistration.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DeviceSummary.Builder>	serializableBuilderClass()
DeviceSummary.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

deviceName

public final String deviceName()

The unique identifier of the device.

Returns:

The unique identifier of the device.

deviceArn

public final String deviceArn()

Amazon Resource Name (ARN) of the device.

Returns:

Amazon Resource Name (ARN) of the device.

description

public final String description()

A description of the device.

Returns:

A description of the device.

deviceFleetName

public final String deviceFleetName()

The name of the fleet the device belongs to.

Returns:

The name of the fleet the device belongs to.

iotThingName

public final String iotThingName()

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..

Returns:

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..

registrationTime

public final Instant registrationTime()

The timestamp of the last registration or de-reregistration.

Returns:

The timestamp of the last registration or de-reregistration.

latestHeartbeat

public final Instant latestHeartbeat()

The last heartbeat received from the device.

Returns:

The last heartbeat received from the device.

hasModels

public final boolean hasModels()

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

models

public final List<EdgeModelSummary> models()

Models on the device.

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

Returns:

Models on the device.

agentVersion

public final String agentVersion()

Edge Manager agent version.

Returns:

Edge Manager agent version.

toBuilder

public DeviceSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeviceSummary.Builder,DeviceSummary>

builder

public static DeviceSummary.Builder builder()

serializableBuilderClass

public static Class<? extends DeviceSummary.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo