com.microsoft.azure.sdk.iot.service.devicetwin

Class DeviceTwinDevice

java.lang.Object

com.microsoft.azure.sdk.iot.service.devicetwin.DeviceTwinDevice

public class DeviceTwinDevice
extends Object

The DeviceTwinDevice class represent the twin on iotHub. implementing constructors and serialization functionality. If object is a representation of the module twin if and only if the moduleId is set.

Constructor Summary

Constructors

Constructor and Description
DeviceTwinDevice() Constructor to create instance for a device
DeviceTwinDevice(String deviceId) Constructor to create instance for a device.
DeviceTwinDevice(String deviceId, String moduleId) Constructor to create instance for a module.

Method Summary

Modifier and Type	Method and Description
void	clearDesiredProperties() Clear desired properties set so far
void	clearTags() Clear tags set so far
void	clearTwin() Clear tags and desired properties set so far
String	desiredPropertiesToString() String representation for this device containing desired properties
com.microsoft.azure.sdk.iot.deps.twin.DeviceCapabilities	getCapabilities() Getter for capabilities
Map<String,com.microsoft.azure.sdk.iot.deps.twin.ConfigurationInfo>	getConfigurations() Getter for the configuration properties
protected com.microsoft.azure.sdk.iot.deps.twin.TwinCollection	getDesiredMap() Getter for the desired properties
Set<Pair>	getDesiredProperties() Getter to get Desired Properties set
Integer	getDesiredPropertiesVersion() Getter for the desired properties version.
String	getDeviceId() Getter to get device ID
String	getETag() Getter for the eTag
String	getModuleId() Getter to get module ID
protected com.microsoft.azure.sdk.iot.deps.twin.TwinCollection	getReportedMap() Getter for the reported properties
Set<Pair>	getReportedProperties() Getter to get Reported Properties Set
Integer	getReportedPropertiesVersion() Getter for the reported properties version.
Set<Pair>	getTags() Getter to get Tags Set
protected com.microsoft.azure.sdk.iot.deps.twin.TwinCollection	getTagsMap() Getter for the tags
Integer	getTagsVersion() Getter for the tag version.
Integer	getVersion() Getter for the Twin version
String	reportedPropertiesToString() String representation for this device containing reported properties
protected void	setCapabilities(com.microsoft.azure.sdk.iot.deps.twin.DeviceCapabilities capabilities) Setter for capabilities
protected void	setConfigurations(Map<String,com.microsoft.azure.sdk.iot.deps.twin.ConfigurationInfo> configurations) Setter for the configuration properties
void	setDesiredProperties(Set<Pair> desiredProperties) Setter for the desired properties
protected void	setDesiredProperties(com.microsoft.azure.sdk.iot.deps.twin.TwinCollection desiredProperties) Setter for the desired properties
void	setETag(String eTag) Setter for ETag
protected void	setReportedProperties(com.microsoft.azure.sdk.iot.deps.twin.TwinCollection reportedProperties) Setter for the reported properties
void	setTags(Set<Pair> tags) Setter for the tags
protected void	setTags(com.microsoft.azure.sdk.iot.deps.twin.TwinCollection tag) Setter for the tags
String	tagsToString() String representation for this device containing tags
String	toString() String representation for this device containing device id, tags, desired and reported properties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DeviceTwinDevice

public DeviceTwinDevice()

Constructor to create instance for a device

DeviceTwinDevice

public DeviceTwinDevice(String deviceId)
                 throws IllegalArgumentException

Constructor to create instance for a device.

Parameters:

deviceId - Device ID for this device

Throws:

IllegalArgumentException - This exception is thrown if the device id is null or empty

DeviceTwinDevice

public DeviceTwinDevice(String deviceId,
                        String moduleId)
                 throws IllegalArgumentException

Constructor to create instance for a module.

Parameters:

deviceId - Device ID for the device which this module belongs to

moduleId - Module ID for this module

Throws:

IllegalArgumentException - This exception is thrown if the device id is null or empty

Method Detail

getDeviceId

public String getDeviceId()

Getter to get device ID

Returns:

device id for this device

getModuleId

public String getModuleId()

Getter to get module ID

Returns:

device id for this device

setETag

public void setETag(String eTag)
             throws IllegalArgumentException

Setter for ETag

Parameters:

eTag - is the value of the etag

Throws:

IllegalArgumentException - if the provided etag is null or empty

getETag

public String getETag()

Getter for the eTag

Returns:

the stored eTag. It will be null if not set.

getVersion

public Integer getVersion()

Getter for the Twin version

Returns:

the stored version. It can be null.

setTags

public void setTags(Set<Pair> tags)
             throws IllegalArgumentException

Setter for the tags

Parameters:

tags - A set of tag key-value pairs

Throws:

IllegalArgumentException - This exception is thrown if the set tags is null

getTags

public Set<Pair> getTags()

Getter to get Tags Set

Returns:

A set of tag key value pairs.

clearTags

public void clearTags()

Clear tags set so far

getTagsVersion

public Integer getTagsVersion()

Getter for the tag version.

Returns:

The Integer with the Tags Collection version.

Throws:

IllegalArgumentException - if the tags is null.

getDesiredProperties

public Set<Pair> getDesiredProperties()

Getter to get Desired Properties set

Returns:

A set of desired property pairs.

setDesiredProperties

public void setDesiredProperties(Set<Pair> desiredProperties)
                          throws IllegalArgumentException

Setter for the desired properties

Parameters:

desiredProperties - A set of key-value pairs for desired properties

Throws:

IllegalArgumentException - This exception is thrown if the set is null

clearDesiredProperties

public void clearDesiredProperties()

Clear desired properties set so far

getDesiredPropertiesVersion

public Integer getDesiredPropertiesVersion()

Getter for the desired properties version.

Returns:

The Integer with the Desired properties Collection version.

Throws:

IllegalArgumentException - if the desired properties is null.

clearTwin

public void clearTwin()

Clear tags and desired properties set so far

getReportedProperties

public Set<Pair> getReportedProperties()

Getter to get Reported Properties Set

Returns:

A set of reported property pairs.

getReportedPropertiesVersion

public Integer getReportedPropertiesVersion()

Getter for the reported properties version.

Returns:

The Integer with the Desired properties Collection version.

Throws:

IllegalArgumentException - if the reported properties is null.

setReportedProperties

protected void setReportedProperties(com.microsoft.azure.sdk.iot.deps.twin.TwinCollection reportedProperties)

Setter for the reported properties

Parameters:

reportedProperties - A map of validated key and value pairs for reported properties

setDesiredProperties

protected void setDesiredProperties(com.microsoft.azure.sdk.iot.deps.twin.TwinCollection desiredProperties)

Setter for the desired properties

Parameters:

desiredProperties - A map of validated key and value pairs for desired properties

setTags

protected void setTags(com.microsoft.azure.sdk.iot.deps.twin.TwinCollection tag)

Setter for the tags

Parameters:

tag - A map of validated key and value pairs for tag

getTagsMap

protected com.microsoft.azure.sdk.iot.deps.twin.TwinCollection getTagsMap()

Getter for the tags

Returns:

A map of validated key and value pairs for tag

getDesiredMap

protected com.microsoft.azure.sdk.iot.deps.twin.TwinCollection getDesiredMap()

Getter for the desired properties

Returns:

A map of validated key and value pairs for desired properties

getReportedMap

protected com.microsoft.azure.sdk.iot.deps.twin.TwinCollection getReportedMap()

Getter for the reported properties

Returns:

A map of validated key and value pairs for reported properties

setConfigurations

protected void setConfigurations(Map<String,com.microsoft.azure.sdk.iot.deps.twin.ConfigurationInfo> configurations)

Setter for the configuration properties

Parameters:

configurations - is the configuration properties.

getConfigurations

public Map<String,com.microsoft.azure.sdk.iot.deps.twin.ConfigurationInfo> getConfigurations()

Getter for the configuration properties

Returns:

the configuration properties. It can be null.

setCapabilities

protected void setCapabilities(com.microsoft.azure.sdk.iot.deps.twin.DeviceCapabilities capabilities)

Setter for capabilities

Parameters:

capabilities - is the value of the capabilities

getCapabilities

public com.microsoft.azure.sdk.iot.deps.twin.DeviceCapabilities getCapabilities()

Getter for capabilities

Returns:

the value of the capabilities. It can be null.

toString

public String toString()

String representation for this device containing device id, tags, desired and reported properties

Overrides:

toString in class Object

Returns:

String representation for this device

tagsToString

public String tagsToString()

String representation for this device containing tags

Returns:

String representation for this device tags

desiredPropertiesToString

public String desiredPropertiesToString()

String representation for this device containing desired properties

Returns:

String representation for this device desired properties

reportedPropertiesToString

public String reportedPropertiesToString()

String representation for this device containing reported properties

Returns:

String representation for this device reported properties