Class DigitalTwinInstanceSummary

Summary of the digital twin instance

Inheritance
object
DigitalTwinInstanceSummary
Inherited Members
Namespace: Oci.IotService.Models
Assembly: OCI.DotNetSDK.Iot.dll
Syntax
public class DigitalTwinInstanceSummary

Properties

AuthId

Declaration
[JsonProperty(PropertyName = "authId")]
public string AuthId { get; set; }
Property Value
Type Description
string

The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

A short description of the resource.

DigitalTwinAdapterId

Declaration
[JsonProperty(PropertyName = "digitalTwinAdapterId")]
public string DigitalTwinAdapterId { get; set; }
Property Value
Type Description
string

The OCID of the digital twin adapter.

DigitalTwinModelId

Declaration
[JsonProperty(PropertyName = "digitalTwinModelId")]
public string DigitalTwinModelId { get; set; }
Property Value
Type Description
string

The OCID of the digital twin model.

DigitalTwinModelSpecUri

Declaration
[JsonProperty(PropertyName = "digitalTwinModelSpecUri")]
public string DigitalTwinModelSpecUri { get; set; }
Property Value
Type Description
string

The URI of the digital twin model specification.

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Remarks

Required

ExternalKey

Declaration
[JsonProperty(PropertyName = "externalKey")]
public string ExternalKey { get; set; }
Property Value
Type Description
string

A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance. This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case. If not provided, the system will automatically generate one.

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {"Department": "Finance"}

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the resource.
Remarks

Required

IotDomainId

Declaration
[Required(ErrorMessage = "IotDomainId is required.")]
[JsonProperty(PropertyName = "iotDomainId")]
public string IotDomainId { get; set; }
Property Value
Type Description
string

The OCID of the IoT domain.
Remarks

Required

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }
Property Value
Type Description
LifecycleState?

The current state of the digital twin instance.
Remarks

Required

SystemTags

Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
Remarks

Required

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z