com.microsoft.azure.sdk.iot.service.twin

Class TwinMetadata

java.lang.Object

com.microsoft.azure.sdk.iot.service.twin.TwinMetadata

public class TwinMetadata
extends Object

Representation of a single Twin metadata for the TwinCollection.

The metadata is a set of pairs lastUpdated/lastUpdatedVersion for each property and sub-property in the Twin. It is optionally provided by the 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,
          "$lastUpdatedBy": "newconfig",
          "$lastUpdatedByDigest": "637570574076206429",
          "Value":{
              "$lastUpdated":"2017-09-21T02:07:44.238Z",
              "$lastUpdatedVersion":5
          },
          "NewValue":{
              "$lastUpdated":"2017-09-21T02:07:44.238Z",
              "$lastUpdatedVersion":5
          }
      }
  }
 
 

See Also:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	LAST_UPDATE_TAG
static String	LAST_UPDATE_VERSION_TAG
static String	LAST_UPDATED_BY
static String	LAST_UPDATED_BY_DIGEST

Method Summary

Modifier and Type	Method and Description
Date	getLastUpdated() Getter for lastUpdated.
String	getLastUpdatedBy() Getter for lastUpdatedBy.
String	getLastUpdatedByDigest() Getter for lastUpdatedByDigest.
Integer	getLastUpdatedVersion() Getter for lastUpdatedVersion.
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

Field Detail

LAST_UPDATE_TAG

public static final String LAST_UPDATE_TAG

See Also:

Constant Field Values

LAST_UPDATE_VERSION_TAG

public static final String LAST_UPDATE_VERSION_TAG

See Also:

Constant Field Values

LAST_UPDATED_BY

public static final String LAST_UPDATED_BY

See Also:

Constant Field Values

LAST_UPDATED_BY_DIGEST

public static final String LAST_UPDATED_BY_DIGEST

See Also:

Constant Field Values

Method Detail

getLastUpdatedBy

public String getLastUpdatedBy()

Getter for lastUpdatedBy.

Returns:

the String representing the configuration LastUpdatedBy.

getLastUpdatedByDigest

public String getLastUpdatedByDigest()

Getter for lastUpdatedByDigest.

Returns:

the String with the stored lastUpdatedByDigest.

getLastUpdatedVersion

public Integer getLastUpdatedVersion()

Getter for lastUpdatedVersion.

Returns:

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

getLastUpdated

public Date getLastUpdated()

Getter for lastUpdated.

Returns:

the Date with the stored lastUpdated. 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.