Class DeviceDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DeviceDescription.Builder,
DeviceDescription>
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The ARN of the device.An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.static DeviceDescription.Builder
builder()
final String
deviceId()
The unique identifier of the device.final Boolean
enabled()
A Boolean value indicating whether or not the device is enabled.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Attributes property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Double
A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.static Class
<? extends DeviceDescription.Builder> tags()
The tags currently associated with the AWS IoT 1-Click device.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
type()
The type of the device, such as "button".Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
The unique identifier of the device.
- Returns:
- The unique identifier of the device.
-
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
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
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
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
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 interfaceToCopyableBuilder<DeviceDescription.Builder,
DeviceDescription> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-