TwinProperties Class

Package:

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

Maven Artifact:

com.microsoft.azure.sdk.iot.provisioning:provisioning-service-client:1.7.0

• java.lang.Object
• • com.microsoft.azure.sdk.iot.provisioning.service.configs.TwinProperties

public class TwinProperties

Representation of a single Twin Properties for the Device Provisioning Service.

The Properties on the TwinState 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
          }
      }

Method Summary

Modifier and Type	Method and Description
TwinCollection	getDesired() Getter for the desired property.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Method Details

getDesired

public TwinCollection getDesired()

Getter for the desired property.

Returns:

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