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

Class TwinMetadata

java.lang.Object

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

public class TwinMetadata
extends Object

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

The metadata is a set of pairs lastUpdated/lastUpdatedVersion for each property and sub-property in the Twin. It is optionally provided by the provisioning service and the clients can only ready it.

This class store the Date and Version for each entity in the TwinCollection.

For instance, the following is a valid TwinCollection with its metadata.

 
  "$metadata":{
      "$lastUpdated":"2017-09-21T02:07:44.238Z",
      "$lastUpdatedVersion":4,
      "MaxSpeed":{
          "$lastUpdated":"2017-09-21T02:07:44.238Z",
          "$lastUpdatedVersion":3,
          "Value":{
              "$lastUpdated":"2017-09-21T02:07:44.238Z",
              "$lastUpdatedVersion":5
          },
          "NewValue":{
              "$lastUpdated":"2017-09-21T02:07:44.238Z",
              "$lastUpdatedVersion":5
          }
      }
  }
 
 

See Also:

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

Method Summary

Modifier and Type	Method and Description
Date	getLastUpdated() Getter for the lastUpdated.
Integer	getLastUpdatedVersion() Getter for the lastUpdatedVersion.

Methods inherited from class java.lang.Object

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

Method Detail

getLastUpdatedVersion

public Integer getLastUpdatedVersion()

Getter for the lastUpdatedVersion.

Returns:

the Integer with the stored lastUpdatedVersion. It can be null.

getLastUpdated

public Date getLastUpdated()

Getter for the lastUpdated.

Returns:

the Date with the stored lastUpdated. It can be null.