com.microsoft.azure.sdk.iot.provisioning.service.configs

Class TwinState

java.lang.Object

com.microsoft.azure.sdk.iot.provisioning.service.configs.TwinState

public class TwinState
extends Object

Representation of a single Twin initial state for the Device Provisioning Service.

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
                  }
              }
          }
      }
     
 

See Also:

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
TwinCollection	getDesiredProperty() Getter for the desired property.
TwinCollection	getTags() Getter for the tags.
String	toString() Creates a pretty print JSON with the content of this class and subclasses.

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)

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 initial desired properties. It can be null.

Method Detail

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.

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.