Share via

DigitalTwinsModelData Class

  • Reference
Package:
com.azure.digitaltwins.core.models
Maven Artifact:
com.azure:azure-digitaltwins-core:1.3.19
  • java.lang.Object
    • com.azure.digitaltwins.core.models.DigitalTwinsModelData

public final class DigitalTwinsModelData

The DigitalTwinsModelData representing the model and its corresponding metadata.

Constructor Summary

Constructor Description
DigitalTwinsModelData(String modelId, String dtdlModel, Map<String,String> displayName, Map<String,String> description, OffsetDateTime uploadedOn, boolean decommissioned)

Construct a new DigitalTwinsModelData instance.

Method Summary

Modifier and Type Method and Description
Map<String,String> getDescriptionLanguageMap()

Get the description property: A language map that contains the localized descriptions as specified in the model definition.
Map<String,String> getDisplayNameLanguageMap()

Get the displayName property: A language map that contains the localized display names as specified in the model definition.
String getDtdlModel()

Get the model property: The model definition.
String getModelId()

Get the id property: The id of the model as specified in the model definition.
OffsetDateTime getUploadedOn()

Get the time the model was uploaded to the service.
boolean isDecommissioned()

Get the decommissioned property: Indicates if the model is decommissioned.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DigitalTwinsModelData

public DigitalTwinsModelData(String modelId, String dtdlModel, Map displayName, Map description, OffsetDateTime uploadedOn, boolean decommissioned)

Construct a new DigitalTwinsModelData instance. This class should only be constructed internally since the service never takes this as an input.

Parameters:

modelId - The Id of the model.
dtdlModel - The contents of the model.
displayName - The language map of the localized display names.
description - The language map of the localized descriptions.
uploadedOn - The time when this model was uploaded.
decommissioned - If this model has been decommissioned.

Method Details

getDescriptionLanguageMap

public Map getDescriptionLanguageMap()

Get the description property: A language map that contains the localized descriptions as specified in the model definition.

Returns:

the description value.

getDisplayNameLanguageMap

public Map getDisplayNameLanguageMap()

Get the displayName property: A language map that contains the localized display names as specified in the model definition.

Returns:

the displayName value.

getDtdlModel

public String getDtdlModel()

Get the model property: The model definition.

Returns:

the model value.

getModelId

public String getModelId()

Get the id property: The id of the model as specified in the model definition.

Returns:

the id value.

getUploadedOn

public OffsetDateTime getUploadedOn()

Get the time the model was uploaded to the service.

Returns:

the uploadTime value.

isDecommissioned

public boolean isDecommissioned()

Get the decommissioned property: Indicates if the model is decommissioned. Decommissioned models cannot be referenced by newly created digital twins.

Returns:

the decommissioned value.

Applies to