DeviceDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iot1clickdevices.model.DeviceDescription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DeviceDescription
extends Object
implements Serializable, Cloneable, StructuredPojo

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DeviceDescription()

Constructors
Constructor and Description
`DeviceDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DeviceDescription`	`addAttributesEntry(String key, String value)` Add a single Attributes entry
`DeviceDescription`	`addTagsEntry(String key, String value)` Add a single Tags entry
`DeviceDescription`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`DeviceDescription`	`clearTagsEntries()` Removes all the entries added into Tags.
`DeviceDescription`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The ARN of the device.
`Map<String,String>`	`getAttributes()` An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.
`String`	`getDeviceId()` The unique identifier of the device.
`Boolean`	`getEnabled()` A Boolean value indicating whether or not the device is enabled.
`Double`	`getRemainingLife()` A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.
`Map<String,String>`	`getTags()` The tags currently associated with the AWS IoT 1-Click device.
`String`	`getType()` The type of the device, such as "button".
`int`	`hashCode()`
`Boolean`	`isEnabled()` A Boolean value indicating whether or not the device is enabled.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The ARN of the device.
`void`	`setAttributes(Map<String,String> attributes)` An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.
`void`	`setDeviceId(String deviceId)` The unique identifier of the device.
`void`	`setEnabled(Boolean enabled)` A Boolean value indicating whether or not the device is enabled.
`void`	`setRemainingLife(Double remainingLife)` A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.
`void`	`setTags(Map<String,String> tags)` The tags currently associated with the AWS IoT 1-Click device.
`void`	`setType(String type)` The type of the device, such as "button".
`String`	`toString()` Returns a string representation of this object.
`DeviceDescription`	`withArn(String arn)` The ARN of the device.
`DeviceDescription`	`withAttributes(Map<String,String> attributes)` An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.
`DeviceDescription`	`withDeviceId(String deviceId)` The unique identifier of the device.
`DeviceDescription`	`withEnabled(Boolean enabled)` A Boolean value indicating whether or not the device is enabled.
`DeviceDescription`	`withRemainingLife(Double remainingLife)` A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.
`DeviceDescription`	`withTags(Map<String,String> tags)` The tags currently associated with the AWS IoT 1-Click device.
`DeviceDescription`	`withType(String type)` The type of the device, such as "button".

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DeviceDescription
```
public DeviceDescription()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The ARN of the device.
    
    Parameters:
    
    arn - The ARN of the device.
  - getArn
```
public String getArn()
```
    The ARN of the device.
    
    Returns:
    
    The ARN of the device.
  - withArn
```
public DeviceDescription withArn(String arn)
```
    The ARN of the device.
    
    Parameters:
    
    arn - The ARN of the device.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttributes
```
public Map<String,String> getAttributes()
```
    An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.
    
    Returns:
    
    An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
    An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.
    
    Parameters:
    
    attributes - An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.
  - withAttributes
```
public DeviceDescription withAttributes(Map<String,String> attributes)
```
    An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.
    
    Parameters:
    
    attributes - An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributesEntry
```
public DeviceDescription addAttributesEntry(String key,
                                            String value)
```
    Add a single Attributes entry
    
    See Also:
    
    withAttributes(java.util.Map<java.lang.String, java.lang.String>)
  - clearAttributesEntries
```
public DeviceDescription clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeviceId
```
public void setDeviceId(String deviceId)
```
    The unique identifier of the device.
    
    Parameters:
    
    deviceId - The unique identifier of the device.
  - getDeviceId
```
public String getDeviceId()
```
    The unique identifier of the device.
    
    Returns:
    
    The unique identifier of the device.
  - withDeviceId
```
public DeviceDescription withDeviceId(String deviceId)
```
    The unique identifier of the device.
    
    Parameters:
    
    deviceId - The unique identifier of the device.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
    A Boolean value indicating whether or not the device is enabled.
    
    Parameters:
    
    enabled - A Boolean value indicating whether or not the device is enabled.
  - getEnabled
```
public Boolean getEnabled()
```
    A Boolean value indicating whether or not the device is enabled.
    
    Returns:
    
    A Boolean value indicating whether or not the device is enabled.
  - withEnabled
```
public DeviceDescription withEnabled(Boolean enabled)
```
    A Boolean value indicating whether or not the device is enabled.
    
    Parameters:
    
    enabled - A Boolean value indicating whether or not the device is enabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnabled
```
public Boolean isEnabled()
```
    A Boolean value indicating whether or not the device is enabled.
    
    Returns:
    
    A Boolean value indicating whether or not the device is enabled.
  - setRemainingLife
```
public void setRemainingLife(Double remainingLife)
```
    A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.
    
    Parameters:
    
    remainingLife - A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.
  - getRemainingLife
```
public Double getRemainingLife()
```
    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.
  - withRemainingLife
```
public DeviceDescription withRemainingLife(Double remainingLife)
```
    A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.
    
    Parameters:
    
    remainingLife - A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of the device, such as "button".
    
    Parameters:
    
    type - The type of the device, such as "button".
  - getType
```
public String getType()
```
    The type of the device, such as "button".
    
    Returns:
    
    The type of the device, such as "button".
  - withType
```
public DeviceDescription withType(String type)
```
    The type of the device, such as "button".
    
    Parameters:
    
    type - The type of the device, such as "button".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The tags currently associated with the AWS IoT 1-Click device.
    
    Returns:
    
    The tags currently associated with the AWS IoT 1-Click device.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags currently associated with the AWS IoT 1-Click device.
    
    Parameters:
    
    tags - The tags currently associated with the AWS IoT 1-Click device.
  - withTags
```
public DeviceDescription withTags(Map<String,String> tags)
```
    The tags currently associated with the AWS IoT 1-Click device.
    
    Parameters:
    
    tags - The tags currently associated with the AWS IoT 1-Click device.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public DeviceDescription addTagsEntry(String key,
                                      String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public DeviceDescription clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DeviceDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class DeviceDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DeviceDescription

Method Detail

setArn

getArn

withArn

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

setDeviceId

getDeviceId

withDeviceId

setEnabled

getEnabled

withEnabled

isEnabled

setRemainingLife

getRemainingLife

withRemainingLife

setType

getType

withType

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall