com.microsoft.azure.sdk.iot.deps.twin

Class TwinState

java.lang.Object

com.microsoft.azure.sdk.iot.deps.twin.RegisterManager

com.microsoft.azure.sdk.iot.deps.twin.TwinState

public class TwinState
extends RegisterManager

Representation of a single Twin.

The TwinState can contain one TwinCollection of Tags, and one TwinCollection of properties.desired.

Each entity in the collections can contain a associated TwinMetadata.

These metadata are provided by the Service and contains information about the last updated date time, and version.

For instance, the following is a valid TwinState, represented as initialTwin in the rest API.

     
      {
          "initialTwin": {
              "tags":{
                  "SpeedUnity":"MPH",
                  "$metadata":{
                      "$lastUpdated":"2017-09-21T02:07:44.238Z",
                      "$lastUpdatedVersion":4,
                      "SpeedUnity":{
                          "$lastUpdated":"2017-09-21T02:07:44.238Z",
                          "$lastUpdatedVersion":4
                      }
                  },
                  "$version":4
              },
              "properties":{
                  "desired": {
                      "MaxSpeed":{
                          "Value":500,
                          "NewValue":300
                      },
                      "$metadata":{
                          "$lastUpdated":"2017-09-21T02:07:44.238Z",
                          "$lastUpdatedVersion":4,
                          "MaxSpeed":{
                              "$lastUpdated":"2017-09-21T02:07:44.238Z",
                              "$lastUpdatedVersion":4,
                              "Value":{
                                  "$lastUpdated":"2017-09-21T02:07:44.238Z",
                                  "$lastUpdatedVersion":4
                              },
                              "NewValue":{
                                  "$lastUpdated":"2017-09-21T02:07:44.238Z",
                                  "$lastUpdatedVersion":4
                              }
                          }
                      },
                      "$version":4
                  },
                  "reported": {
                      "MaxSpeed":{
                          "Value":500,
                          "NewValue":300
                      },
                      "$metadata":{
                          "$lastUpdated":"2017-09-21T02:07:44.238Z",
                          "$lastUpdatedVersion":5,
                          "MaxSpeed":{
                              "$lastUpdated":"2017-09-21T02:07:44.238Z",
                              "$lastUpdatedVersion":4,
                              "Value":{
                                  "$lastUpdated":"2017-09-21T02:07:44.238Z",
                                  "$lastUpdatedVersion":5
                              },
                              "NewValue":{
                                  "$lastUpdated":"2017-09-21T02:07:44.238Z",
                                  "$lastUpdatedVersion":4
                              }
                          }
                      },
                      "$version":6
                  }
              }
          }
      }
     
 

See Also:

Understand and use device twins in IoT Hub, Device Twin Api

Field Summary

Fields inherited from class com.microsoft.azure.sdk.iot.deps.twin.RegisterManager

capabilities, connectionState, connectionStateUpdatedTime, deviceId, eTag, generationId, lastActivityTime, moduleId, status, statusReason, statusUpdatedTime, version

Constructor Summary

Constructors

Constructor and Description
TwinState(TwinCollection tags, TwinCollection desiredProperty, TwinCollection reportedProperty) CONSTRUCTOR

Method Summary

Modifier and Type	Method and Description
static TwinState	createFromDesiredPropertyJson(String json) Factory
static TwinState	createFromPropertiesJson(String json) Factory
static TwinState	createFromReportedPropertyJson(String json) Factory
static TwinState	createFromTwinJson(String json) Factory
Map<String,ConfigurationInfo>	getConfigurations() Getter for the configurations
TwinCollection	getDesiredProperty() Getter for the desired property.
TwinCollection	getReportedProperty() Getter for the reported property.
TwinCollection	getTags() Getter for the tags.
com.google.gson.JsonElement	toJsonElement() Serializer
String	toString() Creates a pretty print JSON with the content of this class and subclasses.

Methods inherited from class com.microsoft.azure.sdk.iot.deps.twin.RegisterManager

getCapabilities, getDeviceId, getETag, getModuleId, getVersion, setCapabilities, setDeviceId, setETag, setModuleId

Methods inherited from class java.lang.Object

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

Constructor Detail

TwinState

public TwinState(TwinCollection tags,
                 TwinCollection desiredProperty,
                 TwinCollection reportedProperty)

CONSTRUCTOR

This constructor creates an instance of the TwinState with the provided TwinCollection tags and desired properties.

When serialized, this class will looks like the following example:

     
          "initialTwin": {
              "tags":{
                  "SpeedUnity":"MPH",
                  "$version":4
              }
              "properties":{
                  "desired":{
                      "MaxSpeed":{
                          "Value":500,
                          "NewValue":300
                      },
                      "$version":4
                  }
              }
          }
      
     }
 

Parameters:

tags - the TwinCollection with the initial tags state. It can be null.

desiredProperty - the TwinCollection with the desired properties. It can be null.

reportedProperty - the TwinCollection with the reported properties. It can be null.

Method Detail

toJsonElement

public com.google.gson.JsonElement toJsonElement()

Serializer

Creates a JsonElement, which the content represents the information in this class and its subclasses in a JSON format. This is useful if the caller will integrate this JSON with JSON from other classes to generate a consolidated JSON.

Returns:

The JsonElement with the content of this class.

getTags

public TwinCollection getTags()

Getter for the tags.

Returns:

The TwinCollection with the tags content. It can be null.

getDesiredProperty

public TwinCollection getDesiredProperty()

Getter for the desired property.

Returns:

The TwinCollection with the desired property content. It can be null.

getReportedProperty

public TwinCollection getReportedProperty()

Getter for the reported property.

Returns:

The TwinCollection with the reported property content. It can be null.

getConfigurations

public Map<String,ConfigurationInfo> getConfigurations()

Getter for the configurations

Returns:

The configurations. It can be null.

toString

public String toString()

Creates a pretty print JSON with the content of this class and subclasses.

Overrides:

toString in class Object

Returns:

The String with the pretty print JSON.

createFromTwinJson

public static TwinState createFromTwinJson(String json)

Factory

Create a new instance of the TwinState parsing the provided string as a JSON with the full Twin information.

Parameters:

json - the String with the JSON received from the service. It cannot be null or empty.

Returns:

The new instance of the TwinState.

createFromDesiredPropertyJson

public static TwinState createFromDesiredPropertyJson(String json)

Factory

Create a new instance of the TwinState parsing the provided string as a JSON with only desired properties information.

Parameters:

json - the String with the JSON received from the service. It cannot be null or empty.

Returns:

The new instance of the TwinState.

createFromReportedPropertyJson

public static TwinState createFromReportedPropertyJson(String json)

Factory

Create a new instance of the TwinState parsing the provided string as a JSON with only reported properties information.

Parameters:

json - the String with the JSON received from the service. It cannot be null or empty.

Returns:

The new instance of the TwinState.

createFromPropertiesJson

public static TwinState createFromPropertiesJson(String json)

Factory

Create a new instance of the TwinState parsing the provided string as a JSON with only desired properties information.

Parameters:

json - the String with the JSON received from the service. It cannot be null or empty.

Returns:

The new instance of the TwinState.