85 строки
8.6 KiB
YAML
85 строки
8.6 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.deps.twin.TwinProperties"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.twin.TwinProperties"
|
|
name: "TwinProperties"
|
|
nameWithType: "TwinProperties"
|
|
summary: "Representation of a single Twin Properties for the <xref uid=\"com.microsoft.azure.sdk.iot.deps.twin.TwinState\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TwinState\"></xref>."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **TwinProperties**"
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.getDesired()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.getDesired()"
|
|
name: "getDesired()"
|
|
nameWithType: "TwinProperties.getDesired()"
|
|
summary: "Getter for the desired property."
|
|
syntax: "public TwinCollection getDesired()"
|
|
desc: "Getter for the desired property."
|
|
returns:
|
|
description: "The <code>TwinCollection</code> with the desired property content. It can be <code>null</code>."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.twin.TwinCollection?alt=com.microsoft.azure.sdk.iot.deps.twin.TwinCollection&text=TwinCollection\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.getReported()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.getReported()"
|
|
name: "getReported()"
|
|
nameWithType: "TwinProperties.getReported()"
|
|
summary: "Getter for the reported property."
|
|
syntax: "public TwinCollection getReported()"
|
|
desc: "Getter for the reported property."
|
|
returns:
|
|
description: "The <code>TwinCollection</code> with the reported property content. It can be <code>null</code>."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.twin.TwinCollection?alt=com.microsoft.azure.sdk.iot.deps.twin.TwinCollection&text=TwinCollection\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.toJsonElement()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.toJsonElement()"
|
|
name: "toJsonElement()"
|
|
nameWithType: "TwinProperties.toJsonElement()"
|
|
summary: "Serializer"
|
|
modifiers:
|
|
- "protected"
|
|
syntax: "protected JsonElement toJsonElement()"
|
|
desc: "Serializer\n\nCreates a `JsonElement`, which the content represents the information in this class and its subclasses in a JSON format. This is useful if the caller will integrate this JSON with JSON from other classes to generate a consolidated JSON."
|
|
returns:
|
|
description: "The <code>JsonElement</code> with the content of this class."
|
|
type: "<xref href=\"com.google.gson.JsonElement?alt=com.google.gson.JsonElement&text=JsonElement\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.toJsonElementWithMetadata()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.toJsonElementWithMetadata()"
|
|
name: "toJsonElementWithMetadata()"
|
|
nameWithType: "TwinProperties.toJsonElementWithMetadata()"
|
|
summary: "Serializer"
|
|
modifiers:
|
|
- "protected"
|
|
syntax: "protected JsonElement toJsonElementWithMetadata()"
|
|
desc: "Serializer\n\nCreates a `JsonElement`, which the content represents the information in this class and its subclasses in a JSON format. If the desired property contains metadata, this method will include it in the final JSON. This is useful if the caller will integrate this JSON with JSON from other classes to generate a consolidated JSON."
|
|
returns:
|
|
description: "The <code>JsonElement</code> with the content of this class."
|
|
type: "<xref href=\"com.google.gson.JsonElement?alt=com.google.gson.JsonElement&text=JsonElement\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.toString()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.twin.TwinProperties.toString()"
|
|
name: "toString()"
|
|
nameWithType: "TwinProperties.toString()"
|
|
summary: "Creates a pretty print JSON with the content of this class and subclasses."
|
|
overridden: "java.lang.Object.toString()"
|
|
syntax: "public String toString()"
|
|
desc: "Creates a pretty print JSON with the content of this class and subclasses."
|
|
returns:
|
|
description: "The <code>String</code> with the pretty print JSON."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Representation of a single Twin Properties for the <xref uid=\"com.microsoft.azure.sdk.iot.deps.twin.TwinState\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TwinState\"></xref>.\n\nThe Properties on the TwinState shall contains one <xref uid=\"com.microsoft.azure.sdk.iot.deps.twin.TwinCollection\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TwinCollection\"></xref> of **desired** property.\n\nThe desired property is a collection that can contain a associated <xref uid=\"com.microsoft.azure.sdk.iot.deps.twin.TwinMetadata\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TwinMetadata\"></xref>.\n\nThese metadata are provided by the Service and contains information about the last updated date time, and version.\n\nFor instance, the following is a valid desired property, represented as `properties.desired` in the rest API.\n\n```java\n{\n \"desired\": {\n \"MaxSpeed\":{\n \"Value\":500,\n \"NewValue\":300\n },\n \"$metadata\":{\n \"$lastUpdated\":\"2017-09-21T02:07:44.238Z\",\n \"$lastUpdatedVersion\":4,\n \"MaxSpeed\":{\n \"$lastUpdated\":\"2017-09-21T02:07:44.238Z\",\n \"$lastUpdatedVersion\":4,\n \"Value\":{\n \"$lastUpdated\":\"2017-09-21T02:07:44.238Z\",\n \"$lastUpdatedVersion\":4\n },\n \"NewValue\":{\n \"$lastUpdated\":\"2017-09-21T02:07:44.238Z\",\n \"$lastUpdatedVersion\":4\n }\n }\n },\n \"$version\":4\n },\n \"reported\": {\n \"MaxSpeed\":{\n \"Value\":500,\n \"NewValue\":300\n },\n \"$metadata\":{\n \"$lastUpdated\":\"2017-09-21T02:07:44.238Z\",\n \"$lastUpdatedVersion\":5,\n \"MaxSpeed\":{\n \"$lastUpdated\":\"2017-09-21T02:07:44.238Z\",\n \"$lastUpdatedVersion\":4,\n \"Value\":{\n \"$lastUpdated\":\"2017-09-21T02:07:44.238Z\",\n \"$lastUpdatedVersion\":5\n },\n \"NewValue\":{\n \"$lastUpdated\":\"2017-09-21T02:07:44.238Z\",\n \"$lastUpdatedVersion\":4\n }\n }\n },\n \"$version\":6\n }\n }\n```"
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.deps.twin"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-deps:0.12.0
|