com.microsoft.azure.sdk.iot.service.digitaltwin.serialization

Class BasicDigitalTwin

java.lang.Object

com.microsoft.azure.sdk.iot.service.digitaltwin.serialization.BasicDigitalTwin

public final class BasicDigitalTwin
extends Object

An optional, helper class for deserializing a digital twin. Only properties with non-null values are included.

Constructor Summary

Constructors

Constructor and Description
BasicDigitalTwin()

Method Summary

Modifier and Type	Method and Description
BasicDigitalTwin	addCustomProperty(String key, Object value) Adds an additional property to the digital twin.
Map<String,Object>	getCustomProperties() Gets the additional properties of the digital twin.
String	getId() Gets the unique Id of the digital twin in a digital twins instance.
DigitalTwinMetadata	getMetadata() Gets the information about the model a digital twin conforms to.
BasicDigitalTwin	setId(String id) Sets the unique Id of the digital twin in a digital twins instance.
BasicDigitalTwin	setMetadata(DigitalTwinMetadata metadata) Sets the information about the model a digital twin conforms to.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicDigitalTwin

public BasicDigitalTwin()

Method Detail

getId

public String getId()

Gets the unique Id of the digital twin in a digital twins instance. This field is present on every digital twin.

Returns:

The unique Id of the digital twin in a digital twins instance. This field is present on every digital twin.

setId

public BasicDigitalTwin setId(String id)

Sets the unique Id of the digital twin in a digital twins instance. This field is present on every digital twin.

Parameters:

id - The unique Id of the digital twin in a digital twins instance. This field is present on every digital twin.

Returns:

The BasicDigitalTwin object itself.

getMetadata

public DigitalTwinMetadata getMetadata()

Gets the information about the model a digital twin conforms to. This field is present on every digital twin.

Returns:

The information about the model a digital twin conforms to. This field is present on every digital twin.

setMetadata

public BasicDigitalTwin setMetadata(DigitalTwinMetadata metadata)

Sets the information about the model a digital twin conforms to. This field is present on every digital twin.

Parameters:

metadata - The information about the model a digital twin conforms to. This field is present on every digital twin.

Returns:

The BasicDigitalTwin object itself.

getCustomProperties

public Map<String,Object> getCustomProperties()

Gets the additional properties of the digital twin. This field will contain any properties of the digital twin that are not already defined by the other strong types of this class.

Returns:

The additional properties of the digital twin. This field will contain any properties of the digital twin that are not already defined by the other strong types of this class.

addCustomProperty

public BasicDigitalTwin addCustomProperty(String key,
                                          Object value)

Adds an additional property to the digital twin. This field will contain any properties of the digital twin that are not already defined by the other strong types of this class.

Parameters:

key - The key of the additional property to be added to the digital twin.

value - The value of the additional property to be added to the digital twin.

Returns:

The BasicDigitalTwin object itself.