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

Represent the twin on IoT hub. Implementing constructors and serialization functionality.

The object is a representation of a module twin if and only if the moduleId is set.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clearDesiredProperties() Clears the desired properties set so far.
void	clearTags() Clears the 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 configuration properties.
String	getConnectionState()
protected com.microsoft.azure.sdk.iot.deps.twin.TwinCollection	getDesiredMap() Getter for desired properties.
Set<Pair>	getDesiredProperties() Getter to get the desired properties setter.
Integer	getDesiredPropertiesVersion() Getter for the desired properties version.
String	getDeviceId() Getter to get the device Id.
String	getDeviceScope() The scope of the device.
String	getETag() Getter for the ETag.
String	getModelId() Getter for a model Id.
String	getModuleId() Getter to get the module Id.
List<String>	getParentScopes() The scopes of the upper level edge devices if applicable.
protected com.microsoft.azure.sdk.iot.deps.twin.TwinCollection	getReportedMap() Getter for reported properties.
Set<Pair>	getReportedProperties() Getter to get reported properties setter.
Integer	getReportedPropertiesVersion() Getter for the reported properties version.
Set<Pair>	getTags() Getter for the twin tags.
protected com.microsoft.azure.sdk.iot.deps.twin.TwinCollection	getTagsMap() Getter for 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 configuration properties.
protected void	setConnectionState(String connectionState) Sets the connection state of the device.
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.
protected void	setDeviceScope(String deviceScope) Sets the device scope.
void	setETag(String eTag) Setter for ETag.
void	setModelId(String modelId) Setter for a model Id
protected void	setParentScopes(List<String> parentScopes) Sets the parent scopes.
protected void	setReportedProperties(com.microsoft.azure.sdk.iot.deps.twin.TwinCollection reportedProperties) Setter for the reported properties.
void	setTags(Set<Pair> tags) Setter for twin tags.
protected void	setTags(com.microsoft.azure.sdk.iot.deps.twin.TwinCollection tag) Setter for 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 an instance for a device.

DeviceTwinDevice

public DeviceTwinDevice(String deviceId)
                 throws IllegalArgumentException

Constructor to create instance for a device.

Parameters:

deviceId - 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 an instance for a module.

Parameters:

deviceId - Id for this device.

moduleId - Id for this device's module.

Throws:

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

Method Detail

getDeviceId

public String getDeviceId()

Getter to get the device Id.

Returns:

The Id for this device.

getModuleId

public String getModuleId()

Getter to get the module Id.

Returns:

The Id for this module.

setETag

public void setETag(String eTag)
             throws IllegalArgumentException

Setter for ETag.

Parameters:

eTag - 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 twin 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 for the twin tags.

Returns:

A set of tag key/value pairs.

clearTags

public void clearTags()

Clears the 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 the desired properties setter.

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

Clears the 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 setter.

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/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/value pairs for desired properties.

setTags

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

Setter for tags.

Parameters:

tag - A map of validated key/value pairs for tags.

getTagsMap

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

Getter for tags.

Returns:

A map of validated key/value pairs for tags.

getDesiredMap

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

Getter for desired properties.

Returns:

A map of validated key/value pairs for desired properties.

getReportedMap

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

Getter for reported properties.

Returns:

A map of validated key/value pairs for reported properties.

setConfigurations

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

Setter for configuration properties.

Parameters:

configurations - Is the configuration properties.

getConfigurations

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

Getter for configuration properties.

Returns:

The configuration properties which can be null.

setCapabilities

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

Setter for capabilities.

Parameters:

capabilities - The value of capabilities.

getCapabilities

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

Getter for capabilities.

Returns:

The value of capabilities, which can be null.

getConnectionState

public String getConnectionState()

Returns:

Gets the connection state as last reported by the service.

setConnectionState

protected void setConnectionState(String connectionState)

Sets the connection state of the device.

Parameters:

connectionState - The state to set.

setDeviceScope

protected void setDeviceScope(String deviceScope)

Sets the device scope.

Parameters:

deviceScope - The device scope to set.

setParentScopes

protected void setParentScopes(List<String> parentScopes)

Sets the parent scopes.

Parameters:

parentScopes - The parent scopes.

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.

getModelId

public String getModelId()

Getter for a model Id.

Returns:

The DTDL model Id of the device. The value will be null for a non-PnP device. The value will be null for a PnP device until the device connects and registers with a model Id.

setModelId

public void setModelId(String modelId)

Setter for a model Id

Parameters:

modelId - is the DTDL model Id of the device.

getDeviceScope

public String getDeviceScope()

The scope of the device. Auto-generated and immutable for edge devices and modifiable in leaf devices to create child/parent relationship.

For more information, see this document.

Returns:

The scope of the device. Auto-generated and immutable for edge devices and modifiable in leaf devices to create child/parent relationship.

getParentScopes

public List<String> getParentScopes()

The scopes of the upper level edge devices if applicable. Only available for edge devices.

For more information, see this document.

Returns:

The parent scopes edge and leaf devices, if applicable.