azure-docs-sdk-java/docs-ref-autogen/com.azure.digitaltwins.core...

89 строки
7.0 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.digitaltwins.core.BasicDigitalTwinMetadata"
fullName: "com.azure.digitaltwins.core.BasicDigitalTwinMetadata"
name: "BasicDigitalTwinMetadata"
nameWithType: "BasicDigitalTwinMetadata"
summary: "An optional, helper class for deserializing a digital twin."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **BasicDigitalTwinMetadata**"
constructors:
- uid: "com.azure.digitaltwins.core.BasicDigitalTwinMetadata.BasicDigitalTwinMetadata()"
fullName: "com.azure.digitaltwins.core.BasicDigitalTwinMetadata.BasicDigitalTwinMetadata()"
name: "BasicDigitalTwinMetadata()"
nameWithType: "BasicDigitalTwinMetadata.BasicDigitalTwinMetadata()"
summary: "Creates an instance of digital twin metadata."
syntax: "public BasicDigitalTwinMetadata()"
desc: "Creates an instance of digital twin metadata."
methods:
- uid: "com.azure.digitaltwins.core.BasicDigitalTwinMetadata.addPropertyMetadata(java.lang.String,com.azure.digitaltwins.core.DigitalTwinPropertyMetadata)"
fullName: "com.azure.digitaltwins.core.BasicDigitalTwinMetadata.addPropertyMetadata(String key, DigitalTwinPropertyMetadata value)"
name: "addPropertyMetadata(String key, DigitalTwinPropertyMetadata value)"
nameWithType: "BasicDigitalTwinMetadata.addPropertyMetadata(String key, DigitalTwinPropertyMetadata value)"
summary: "Adds an additional custom property to the digital twin."
parameters:
- description: "The key of the additional property to be added to the digital twin."
name: "key"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The value of the additional property to be added to the digital twin."
name: "value"
type: "<xref href=\"com.azure.digitaltwins.core.DigitalTwinPropertyMetadata?alt=com.azure.digitaltwins.core.DigitalTwinPropertyMetadata&text=DigitalTwinPropertyMetadata\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BasicDigitalTwinMetadata addPropertyMetadata(String key, DigitalTwinPropertyMetadata value)"
desc: "Adds an additional custom property to the digital twin. This field will contain any property of the digital twin that is not already defined by the other strong types of this class."
returns:
description: "The BasicDigitalTwin object itself."
type: "<xref href=\"com.azure.digitaltwins.core.BasicDigitalTwinMetadata?alt=com.azure.digitaltwins.core.BasicDigitalTwinMetadata&text=BasicDigitalTwinMetadata\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.digitaltwins.core.BasicDigitalTwinMetadata.getModelId()"
fullName: "com.azure.digitaltwins.core.BasicDigitalTwinMetadata.getModelId()"
name: "getModelId()"
nameWithType: "BasicDigitalTwinMetadata.getModelId()"
summary: "Gets the Id of the model that the digital twin or component is modeled by."
syntax: "public String getModelId()"
desc: "Gets the Id of the model that the digital twin or component is modeled by."
returns:
description: "The Id of the model that the digital twin or component is modeled by."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.digitaltwins.core.BasicDigitalTwinMetadata.getPropertyMetadata()"
fullName: "com.azure.digitaltwins.core.BasicDigitalTwinMetadata.getPropertyMetadata()"
name: "getPropertyMetadata()"
nameWithType: "BasicDigitalTwinMetadata.getPropertyMetadata()"
summary: "Gets the metadata about changes on properties on a component."
syntax: "public Map<String,DigitalTwinPropertyMetadata> getPropertyMetadata()"
desc: "Gets the metadata about changes on properties on a component. The values can be deserialized into <xref uid=\"com.azure.digitaltwins.core.DigitalTwinPropertyMetadata\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinPropertyMetadata\"></xref>"
returns:
description: "The metadata about changes on properties on a component."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.digitaltwins.core.DigitalTwinPropertyMetadata?alt=com.azure.digitaltwins.core.DigitalTwinPropertyMetadata&text=DigitalTwinPropertyMetadata\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.digitaltwins.core.BasicDigitalTwinMetadata.setModelId(java.lang.String)"
fullName: "com.azure.digitaltwins.core.BasicDigitalTwinMetadata.setModelId(String modelId)"
name: "setModelId(String modelId)"
nameWithType: "BasicDigitalTwinMetadata.setModelId(String modelId)"
summary: "Sets the Id of the model that the digital twin or component is modeled by."
parameters:
- description: "The Id of the model that the digital twin or component is modeled by."
name: "modelId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BasicDigitalTwinMetadata setModelId(String modelId)"
desc: "Sets the Id of the model that the digital twin or component is modeled by."
returns:
description: "The BasicDigitalTwinMetadata object itself."
type: "<xref href=\"com.azure.digitaltwins.core.BasicDigitalTwinMetadata?alt=com.azure.digitaltwins.core.BasicDigitalTwinMetadata&text=BasicDigitalTwinMetadata\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "An optional, helper class for deserializing a digital twin. The $metadata class on a <xref uid=\"com.azure.digitaltwins.core.BasicDigitalTwin\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BasicDigitalTwin\"></xref>. Only properties with non-null values are included."
metadata: {}
package: "com.azure.digitaltwins.core"
artifact: com.azure:azure-digitaltwins-core:1.3.7