573 строки
24 KiB
YAML
573 строки
24 KiB
YAML
### YamlMime:ManagedReference
|
||
items:
|
||
- uid: com.microsoft.azure.sdk.iot.deps.twin._twin_properties
|
||
id: _twin_properties
|
||
parent: com.microsoft.azure.sdk.iot.deps.twin
|
||
children:
|
||
- com.microsoft.azure.sdk.iot.deps.twin._twin_properties.getDesired()
|
||
- com.microsoft.azure.sdk.iot.deps.twin._twin_properties.getReported()
|
||
- com.microsoft.azure.sdk.iot.deps.twin._twin_properties.toJsonElement()
|
||
- com.microsoft.azure.sdk.iot.deps.twin._twin_properties.toJsonElementWithMetadata()
|
||
- com.microsoft.azure.sdk.iot.deps.twin._twin_properties.toString()
|
||
- com.microsoft.azure.sdk.iot.deps.twin._twin_properties.TwinProperties()
|
||
href: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.yml
|
||
langs:
|
||
- java
|
||
name: TwinProperties
|
||
nameWithType: TwinProperties
|
||
fullName: com.microsoft.azure.sdk.iot.deps.twin.TwinProperties
|
||
type: Class
|
||
source:
|
||
remote: &o0
|
||
path: deps/src/main/java/com/microsoft/azure/sdk/iot/deps/twin/TwinProperties.java
|
||
branch: master
|
||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||
path: deps/src/main/java/com/microsoft/azure/sdk/iot/deps/twin/TwinProperties.java
|
||
startLine: 78
|
||
package: com.microsoft.azure.sdk.iot.deps.twin
|
||
summary: >-
|
||
<p>Representation of a single Twin Properties for the <xref uid="com.microsoft.azure.sdk.iot.deps.twin._twin_state" data-throw-if-not-resolved="false">TwinState</xref>.</p>
|
||
|
||
<p>The Properties on the TwinState shall contains one <xref uid="com.microsoft.azure.sdk.iot.deps.twin._twin_collection" data-throw-if-not-resolved="false">TwinCollection</xref> of <b>desired</b> property.</p>
|
||
|
||
<p>The desired property is a collection that can contain a associated <xref uid="com.microsoft.azure.sdk.iot.deps.twin._twin_metadata" data-throw-if-not-resolved="false">TwinMetadata</xref>.</p>
|
||
|
||
<p>These metadata are provided by the Service and contains information about the last updated date time, and version.</p>
|
||
|
||
<p>For instance, the following is a valid desired property, represented as <code>properties.desired
|
||
|
||
</code> in the rest API. <pre><code>{
|
||
|
||
"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
|
||
|
||
}
|
||
|
||
}
|
||
|
||
</code></pre></p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public class TwinProperties
|
||
inheritance:
|
||
- java.lang.Object
|
||
- uid: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.getDesired()
|
||
id: getDesired()
|
||
parent: com.microsoft.azure.sdk.iot.deps.twin._twin_properties
|
||
href: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.yml
|
||
langs:
|
||
- java
|
||
name: getDesired()
|
||
nameWithType: TwinProperties.getDesired()
|
||
fullName: com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.getDesired()
|
||
overload: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.getDesired*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: deps/src/main/java/com/microsoft/azure/sdk/iot/deps/twin/TwinProperties.java
|
||
startLine: 215
|
||
package: com.microsoft.azure.sdk.iot.deps.twin
|
||
summary: >-
|
||
<p>Getter for the desired property.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public TwinCollection getDesired()
|
||
return:
|
||
type: com.microsoft.azure.sdk.iot.deps.twin._twin_collection
|
||
description: >-
|
||
<p>The<code>TwinCollection
|
||
|
||
</code> with the desired property content. It can be<code>null
|
||
|
||
</code> . </p>
|
||
- uid: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.getReported()
|
||
id: getReported()
|
||
parent: com.microsoft.azure.sdk.iot.deps.twin._twin_properties
|
||
href: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.yml
|
||
langs:
|
||
- java
|
||
name: getReported()
|
||
nameWithType: TwinProperties.getReported()
|
||
fullName: com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.getReported()
|
||
overload: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.getReported*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: deps/src/main/java/com/microsoft/azure/sdk/iot/deps/twin/TwinProperties.java
|
||
startLine: 230
|
||
package: com.microsoft.azure.sdk.iot.deps.twin
|
||
summary: >-
|
||
<p>Getter for the reported property.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public TwinCollection getReported()
|
||
return:
|
||
type: com.microsoft.azure.sdk.iot.deps.twin._twin_collection
|
||
description: >-
|
||
<p>The<code>TwinCollection
|
||
|
||
</code> with the reported property content. It can be<code>null
|
||
|
||
</code> . </p>
|
||
- uid: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.toJsonElement()
|
||
id: toJsonElement()
|
||
parent: com.microsoft.azure.sdk.iot.deps.twin._twin_properties
|
||
href: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.yml
|
||
langs:
|
||
- java
|
||
name: toJsonElement()
|
||
nameWithType: TwinProperties.toJsonElement()
|
||
fullName: com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.toJsonElement()
|
||
overload: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.toJsonElement*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: deps/src/main/java/com/microsoft/azure/sdk/iot/deps/twin/TwinProperties.java
|
||
startLine: 154
|
||
package: com.microsoft.azure.sdk.iot.deps.twin
|
||
summary: >-
|
||
<p>Serializer</p>
|
||
|
||
<p>Creates a<code>JsonElement
|
||
|
||
</code> , which the content represents the information in this class and its subclasses in a JSON format.</p>
|
||
|
||
<p>This is useful if the caller will integrate this JSON with JSON from other classes to generate a consolidated JSON. </p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: protected JsonElement toJsonElement()
|
||
return:
|
||
type: 8585b2e7
|
||
description: >-
|
||
<p>The<code>JsonElement
|
||
|
||
</code> with the content of this class. </p>
|
||
- uid: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.toJsonElementWithMetadata()
|
||
id: toJsonElementWithMetadata()
|
||
parent: com.microsoft.azure.sdk.iot.deps.twin._twin_properties
|
||
href: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.yml
|
||
langs:
|
||
- java
|
||
name: toJsonElementWithMetadata()
|
||
nameWithType: TwinProperties.toJsonElementWithMetadata()
|
||
fullName: com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.toJsonElementWithMetadata()
|
||
overload: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.toJsonElementWithMetadata*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: deps/src/main/java/com/microsoft/azure/sdk/iot/deps/twin/TwinProperties.java
|
||
startLine: 190
|
||
package: com.microsoft.azure.sdk.iot.deps.twin
|
||
summary: >-
|
||
<p>Serializer</p>
|
||
|
||
<p>Creates a<code>JsonElement
|
||
|
||
</code> , which the content represents the information in this class and its subclasses in a JSON format.</p>
|
||
|
||
<p>If the desired property contains metadata, this method will include it in the final JSON.</p>
|
||
|
||
<p>This is useful if the caller will integrate this JSON with JSON from other classes to generate a consolidated JSON. </p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: protected JsonElement toJsonElementWithMetadata()
|
||
return:
|
||
type: 8585b2e7
|
||
description: >-
|
||
<p>The<code>JsonElement
|
||
|
||
</code> with the content of this class. </p>
|
||
- uid: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.toString()
|
||
id: toString()
|
||
parent: com.microsoft.azure.sdk.iot.deps.twin._twin_properties
|
||
href: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.yml
|
||
langs:
|
||
- java
|
||
name: toString()
|
||
nameWithType: TwinProperties.toString()
|
||
fullName: com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.toString()
|
||
overload: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.toString*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: deps/src/main/java/com/microsoft/azure/sdk/iot/deps/twin/TwinProperties.java
|
||
startLine: 246
|
||
package: com.microsoft.azure.sdk.iot.deps.twin
|
||
summary: >-
|
||
<p>Creates a pretty print JSON with the content of this class and subclasses.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public String toString()
|
||
return:
|
||
type: "26831127"
|
||
description: >-
|
||
<p>The<code>String
|
||
|
||
</code> with the pretty print JSON. </p>
|
||
- uid: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.TwinProperties()
|
||
id: TwinProperties()
|
||
parent: com.microsoft.azure.sdk.iot.deps.twin._twin_properties
|
||
href: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.yml
|
||
langs:
|
||
- java
|
||
name: TwinProperties()
|
||
nameWithType: TwinProperties.TwinProperties()
|
||
fullName: com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.TwinProperties()
|
||
overload: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.TwinProperties*
|
||
type: Constructor
|
||
source:
|
||
remote: *o0
|
||
path: deps/src/main/java/com/microsoft/azure/sdk/iot/deps/twin/TwinProperties.java
|
||
startLine: 260
|
||
package: com.microsoft.azure.sdk.iot.deps.twin
|
||
summary: >-
|
||
<p>Empty constructor</p>
|
||
|
||
<p>Used only by the tools that will deserialize this class. </p>
|
||
syntax:
|
||
content: protected TwinProperties()
|
||
references:
|
||
- uid: 8585b2e7
|
||
spec.java:
|
||
- name: JsonElement
|
||
fullName: JsonElement
|
||
- uid: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.toJsonElement*
|
||
name: toJsonElement
|
||
nameWithType: TwinProperties.toJsonElement
|
||
fullName: com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.toJsonElement
|
||
package: com.microsoft.azure.sdk.iot.deps.twin
|
||
- uid: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.toJsonElementWithMetadata*
|
||
name: toJsonElementWithMetadata
|
||
nameWithType: TwinProperties.toJsonElementWithMetadata
|
||
fullName: com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.toJsonElementWithMetadata
|
||
package: com.microsoft.azure.sdk.iot.deps.twin
|
||
- uid: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.TwinProperties*
|
||
name: TwinProperties
|
||
nameWithType: TwinProperties.TwinProperties
|
||
fullName: com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.TwinProperties
|
||
package: com.microsoft.azure.sdk.iot.deps.twin
|
||
- uid: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.getDesired*
|
||
name: getDesired
|
||
nameWithType: TwinProperties.getDesired
|
||
fullName: com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.getDesired
|
||
package: com.microsoft.azure.sdk.iot.deps.twin
|
||
- uid: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.getReported*
|
||
name: getReported
|
||
nameWithType: TwinProperties.getReported
|
||
fullName: com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.getReported
|
||
package: com.microsoft.azure.sdk.iot.deps.twin
|
||
- uid: "26831127"
|
||
spec.java:
|
||
- name: String
|
||
fullName: String
|
||
- uid: com.microsoft.azure.sdk.iot.deps.twin._twin_properties.toString*
|
||
name: toString
|
||
nameWithType: TwinProperties.toString
|
||
fullName: com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.toString
|
||
package: com.microsoft.azure.sdk.iot.deps.twin
|
||
- uid: com.microsoft.azure.sdk.iot.deps.twin._twin_collection
|
||
parent: com.microsoft.azure.sdk.iot.deps.twin
|
||
href: com.microsoft.azure.sdk.iot.deps.twin._twin_collection.yml
|
||
name: TwinCollection
|
||
nameWithType: TwinCollection
|
||
fullName: com.microsoft.azure.sdk.iot.deps.twin.TwinCollection
|
||
type: Class
|
||
summary: "<p>Representation of a single Twin collection.</p>\r\n<p>The TwinCollection is an extension of a<code>HashMap \r\n </code> of<code>String \r\n </code> and <code>Object \r\n </code> that contain individual and general versioning mechanism.</p>\r\n<p>By the Twin definition, the<code>Object \r\n </code> can contain types of<code>Boolean \r\n </code> , <code>Number \r\n </code> ,<code>String \r\n </code> ,<code>Object \r\n </code> , or a sub-TwinCollection, but it cannot be types defined by the user or arrays.</p>\r\n<p>A TwinCollection can contain up to 5 levels of sub TwinCollections. Once the TwinCollection is a extension of the<code>HashMap \r\n </code> , both TwinCollection as well as its sub-TwinCollections can be casted to Map of String and Object.</p>\r\n<p>The collection will be represented in the rest API as a JSON in the body. It can or cannot contain the metadata (identified by the <b>$</b> character at the beginning of the key.</p>\r\n<p>Because of the Twin metadata, the character <b>$</b> is not allowed in the entry key.</p>\r\n<p>For instance, the following JSON is a valid TwinCollection with its metadata. <pre><code>{\r\n \"Color\":\"White\",\r\n \"MaxSpeed\":{\r\n \"Value\":500,\r\n \"NewValue\":300\r\n },\r\n \"$metadata\":{\r\n \"$lastUpdated\":\"2017-09-21T02:07:44.238Z\",\r\n \"$lastUpdatedVersion\":4,\r\n \"Color\":{\r\n \"$lastUpdated\":\"2017-09-21T02:07:44.238Z\",\r\n \"$lastUpdatedVersion\":4,\r\n },\r\n \"MaxSpeed\":{\r\n \"$lastUpdated\":\"2017-09-21T02:07:44.238Z\",\r\n \"$lastUpdatedVersion\":4,\r\n \"Value\":{\r\n \"$lastUpdated\":\"2017-09-21T02:07:44.238Z\",\r\n \"$lastUpdatedVersion\":4\r\n },\r\n \"NewValue\":{\r\n \"$lastUpdated\":\"2017-09-21T02:07:44.238Z\",\r\n \"$lastUpdatedVersion\":4\r\n }\r\n }\r\n },\r\n \"$version\":4\r\n }\r\n </code></pre></p>\r\n<p>This class exposes the Twin collection with or without metadata as a Map here user can gat both the value and the metadata. For instance, in the above TwinCollection, <xref uid=\"\" data-throw-if-not-resolved=\"false\">get(Object)</xref> for <b>Color</b> will return <b>White</b> and the <xref uid=\"com.microsoft.azure.sdk.iot.deps.twin._twin_collection.getTwinMetadata(String)\" data-throw-if-not-resolved=\"false\">getTwinMetadata(String)</xref> for <b>Color</b> will return the Object TwinMetadata that contain <xref uid=\"com.microsoft.azure.sdk.iot.deps.twin._twin_metadata.getLastUpdated()\" data-throw-if-not-resolved=\"false\">TwinMetadata#getLastUpdated()</xref> that will returns the<code>Date \r\n </code><b>2017-09-21T02:07:44.238Z</b> and <xref uid=\"com.microsoft.azure.sdk.iot.deps.twin._twin_metadata.getLastUpdatedVersion()\" data-throw-if-not-resolved=\"false\">TwinMetadata#getLastUpdatedVersion()</xref> that will returns the<code>Integer \r\n </code><b>4</b>.</p>\r\n<p>For the nested TwinCollection, you can do the same, for instance, the following code will return the value and metadata of the <b>NewValue</b> nested in <b>MaxSpeed</b>: <pre><code>// Get the value of the MaxSpeed, which is a inner TwinCollection.\r\n TwinCollection innerMaxSpeed = (TwinCollection) twinCollection.get(\"MaxSpeed\");\r\n \r\n // From the inner TwinCollection, get the value of the NewValue.\r\n Long maxSpeedNewValue = innerMaxSpeed.get(\"NewValue\");\r\n \r\n // As in the root TwinCollection, the inner TwinCollection contain its own metadata.\r\n // So, get the metadata information for the inner NewValue.\r\n TwinMetadata maxSpeedNewValueMetadata = innerMaxSpeed.getTwinMetadata(\"NewValue\");\r\n Date newValueLastUpdated = maxSpeedNewValueMetadata.getLastUpdated(); //Shall contain `2017-09-21T02:07:44.238Z`\r\n Integer newValueLastUpdatedVersion = maxSpeedNewValueMetadata.getLastUpdatedVersion(); //Shall contain `4`\r\n </code></pre></p>\r\n<p></p>"
|
||
syntax:
|
||
content: public class TwinCollection
|
||
- uid: com.microsoft.azure.sdk.iot.deps.twin._twin_state
|
||
parent: com.microsoft.azure.sdk.iot.deps.twin
|
||
href: com.microsoft.azure.sdk.iot.deps.twin._twin_state.yml
|
||
name: TwinState
|
||
nameWithType: TwinState
|
||
fullName: com.microsoft.azure.sdk.iot.deps.twin.TwinState
|
||
type: Class
|
||
summary: >-
|
||
<p>Representation of a single Twin.</p>
|
||
|
||
<p>The TwinState can contain one <xref uid="com.microsoft.azure.sdk.iot.deps.twin._twin_collection" data-throw-if-not-resolved="false">TwinCollection</xref> of <b>Tags</b>, and one <xref uid="com.microsoft.azure.sdk.iot.deps.twin._twin_collection" data-throw-if-not-resolved="false">TwinCollection</xref> of <b>properties.desired</b>.</p>
|
||
|
||
<p>Each entity in the collections can contain a associated <xref uid="com.microsoft.azure.sdk.iot.deps.twin._twin_metadata" data-throw-if-not-resolved="false">TwinMetadata</xref>.</p>
|
||
|
||
<p>These metadata are provided by the Service and contains information about the last updated date time, and version.</p>
|
||
|
||
<p>For instance, the following is a valid TwinState, represented as <code>initialTwin
|
||
|
||
</code> in the rest API. <pre><code>{
|
||
|
||
"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
|
||
|
||
},
|
||
|
||
"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
|
||
|
||
}
|
||
|
||
}
|
||
|
||
}
|
||
|
||
}
|
||
|
||
</code></pre></p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public class TwinState
|
||
- uid: com.microsoft.azure.sdk.iot.deps.twin._twin_metadata
|
||
parent: com.microsoft.azure.sdk.iot.deps.twin
|
||
href: com.microsoft.azure.sdk.iot.deps.twin._twin_metadata.yml
|
||
name: TwinMetadata
|
||
nameWithType: TwinMetadata
|
||
fullName: com.microsoft.azure.sdk.iot.deps.twin.TwinMetadata
|
||
type: Class
|
||
summary: >-
|
||
<p>Representation of a single Twin metadata for the <xref uid="com.microsoft.azure.sdk.iot.deps.twin._twin_collection" data-throw-if-not-resolved="false">TwinCollection</xref>.</p>
|
||
|
||
<p>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.</p>
|
||
|
||
<p>This class store the Date and Version for each entity in the <xref uid="com.microsoft.azure.sdk.iot.deps.twin._twin_collection" data-throw-if-not-resolved="false">TwinCollection</xref>.</p>
|
||
|
||
<p>For instance, the following is a valid TwinCollection with its metadata. <pre><code>"$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
|
||
|
||
}
|
||
|
||
}
|
||
|
||
}
|
||
|
||
</code></pre></p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public class TwinMetadata
|