com.microsoft.azure.sdk.iot.device.twin

Class TwinProperties

java.lang.Object

com.microsoft.azure.sdk.iot.device.twin.TwinProperties

public class TwinProperties
extends java.lang.Object

Representation of a single Twin Properties for the Twin.

The Properties on the Twin shall contains one TwinCollection of desired property.

The desired property is a collection that 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 desired property, represented as properties.desired in the rest API.

     
      {
          "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

Method Summary

Modifier and Type	Method and Description
TwinCollection	getDesired() Getter for the desired property.
TwinCollection	getReported() Getter for the reported property.
java.lang.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

Method Detail

getDesired

public TwinCollection getDesired()

Getter for the desired property.

Returns:

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

getReported

public TwinCollection getReported()

Getter for the reported property.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

The String with the pretty print JSON.