Class DeviceDescription
- java.lang.Object
-
- software.amazon.awssdk.services.iot1clickdevices.model.DeviceDescription
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<DeviceDescription.Builder,DeviceDescription>
@Generated("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 Description static interfaceDeviceDescription.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()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.Builderbuilder()StringdeviceId()The unique identifier of the device.Booleanenabled()A Boolean value indicating whether or not the device is enabled.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAttributes()For responses, this returns true if the service returned a value for the Attributes property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.DoubleremainingLife()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.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringtype()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 theisEmpty()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 theisEmpty()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:
toBuilderin interfaceToCopyableBuilder<DeviceDescription.Builder,DeviceDescription>
-
builder
public static DeviceDescription.Builder builder()
-
serializableBuilderClass
public static Class<? extends DeviceDescription.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-