software.amazon.awssdk.services.iot1clickdevices.model

Class DeviceDescription

java.lang.Object

software.amazon.awssdk.services.iot1clickdevices.model.DeviceDescription

All Implemented Interfaces:

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeviceDescription.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The ARN of the device.
Map<String,String>	attributes() An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.
static DeviceDescription.Builder	builder()
String	deviceId() The unique identifier of the device.
Boolean	enabled() A Boolean value indicating whether or not the device is enabled.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes() For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
Double	remainingLife() A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.
List<SdkField<?>>	sdkFields()
static Class<? extends DeviceDescription.Builder>	serializableBuilderClass()
Map<String,String>	tags() The tags currently associated with the AWS IoT 1-Click device.
DeviceDescription.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	type() The type of the device, such as "button".

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

arn

public final String arn()

The ARN of the device.

Returns:

The ARN of the device.

hasAttributes

public final boolean hasAttributes()

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

attributes

public final Map<String,String> attributes()

An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.

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

Returns:

An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.

deviceId

public final String deviceId()

The unique identifier of the device.

Returns:

The unique identifier of the device.

enabled

public final Boolean enabled()

A Boolean value indicating whether or not the device is enabled.

Returns:

A Boolean value indicating whether or not the device is enabled.

remainingLife

public final Double remainingLife()

A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.

Returns:

A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.

type

public final String type()

The type of the device, such as "button".

Returns:

The type of the device, such as "button".

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()

The tags currently associated with the AWS IoT 1-Click 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 hasTags() method.

Returns:

The tags currently associated with the AWS IoT 1-Click device.

toBuilder

public DeviceDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeviceDescription.Builder,DeviceDescription>

builder

public static DeviceDescription.Builder builder()

serializableBuilderClass

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