com.microsoft.azure.sdk.iot.service.twin

Class Twin

java.lang.Object

com.microsoft.azure.sdk.iot.service.twin.Twin

public class Twin
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
Twin() Constructor to create an instance for a device.
Twin(String deviceId) Constructor to create instance for a device.
Twin(String deviceId, String moduleId) Constructor to create an instance for a module.

Method Summary

Modifier and Type	Method and Description
static Twin	fromJson(String json)
TwinCollection	getDesiredProperties() Getter to get the desired properties setter.
TwinCollection	getReportedProperties() Getter to get reported properties setter.
TwinCollection	getTags() Getter for the twin 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

Twin

public Twin()

Constructor to create an instance for a device.

Twin

public Twin(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

Twin

public Twin(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

fromJson

public static Twin fromJson(String json)

getTags

public TwinCollection getTags()

Getter for the twin tags.

Returns:

A set of tag key/value pairs.

getDesiredProperties

public TwinCollection getDesiredProperties()

Getter to get the desired properties setter.

Returns:

A set of desired property pairs.

getReportedProperties

public TwinCollection getReportedProperties()

Getter to get reported properties setter.

Returns:

A set of reported property pairs.

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.