DigitalTwinInstance¶

class oci.iot.models.DigitalTwinInstance(**kwargs)¶

Bases: object

A digital twin instance is a virtual representation of a physical IoT device within the IoT domain.

To use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who needs to create policies to grant users access, see Getting Started with Policies.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DigitalTwinInstance.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DigitalTwinInstance.
`auth_id`	Gets the auth_id of this DigitalTwinInstance.
`defined_tags`	Gets the defined_tags of this DigitalTwinInstance.
`description`	Gets the description of this DigitalTwinInstance.
`digital_twin_adapter_id`	Gets the digital_twin_adapter_id of this DigitalTwinInstance.
`digital_twin_model_id`	Gets the digital_twin_model_id of this DigitalTwinInstance.
`digital_twin_model_spec_uri`	Gets the digital_twin_model_spec_uri of this DigitalTwinInstance.
`display_name`	[Required] Gets the display_name of this DigitalTwinInstance.
`external_key`	Gets the external_key of this DigitalTwinInstance.
`freeform_tags`	Gets the freeform_tags of this DigitalTwinInstance.
`id`	[Required] Gets the id of this DigitalTwinInstance.
`iot_domain_id`	[Required] Gets the iot_domain_id of this DigitalTwinInstance.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DigitalTwinInstance.
`system_tags`	Gets the system_tags of this DigitalTwinInstance.
`time_created`	[Required] Gets the time_created of this DigitalTwinInstance.
`time_updated`	Gets the time_updated of this DigitalTwinInstance.

Methods

__init__(**kwargs) Initializes a new DigitalTwinInstance object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a DigitalTwinInstance. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a DigitalTwinInstance. This constant has a value of “DELETED”

__init__(**kwargs)¶

Initializes a new DigitalTwinInstance object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this DigitalTwinInstance.
iot_domain_id (str) – The value to assign to the iot_domain_id property of this DigitalTwinInstance.
auth_id (str) – The value to assign to the auth_id property of this DigitalTwinInstance.
external_key (str) – The value to assign to the external_key property of this DigitalTwinInstance.
display_name (str) – The value to assign to the display_name property of this DigitalTwinInstance.
description (str) – The value to assign to the description property of this DigitalTwinInstance.
digital_twin_model_id (str) – The value to assign to the digital_twin_model_id property of this DigitalTwinInstance.
digital_twin_model_spec_uri (str) – The value to assign to the digital_twin_model_spec_uri property of this DigitalTwinInstance.
digital_twin_adapter_id (str) – The value to assign to the digital_twin_adapter_id property of this DigitalTwinInstance.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DigitalTwinInstance. Allowed values for this property are: “ACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DigitalTwinInstance.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DigitalTwinInstance.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DigitalTwinInstance.
time_created (datetime) – The value to assign to the time_created property of this DigitalTwinInstance.
time_updated (datetime) – The value to assign to the time_updated property of this DigitalTwinInstance.

auth_id¶

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

Returns:	The auth_id of this DigitalTwinInstance.
Return type:	str

defined_tags¶

Gets the defined_tags of this DigitalTwinInstance. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this DigitalTwinInstance.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this DigitalTwinInstance. A short description of the resource.

Returns:	The description of this DigitalTwinInstance.
Return type:	str

digital_twin_adapter_id¶

Gets the digital_twin_adapter_id of this DigitalTwinInstance. The OCID of the digital twin adapter.

Returns:	The digital_twin_adapter_id of this DigitalTwinInstance.
Return type:	str

digital_twin_model_id¶

Gets the digital_twin_model_id of this DigitalTwinInstance. The OCID of the digital twin model.

Returns:	The digital_twin_model_id of this DigitalTwinInstance.
Return type:	str

digital_twin_model_spec_uri¶

Gets the digital_twin_model_spec_uri of this DigitalTwinInstance. The URI of the digital twin model specification.

Returns:	The digital_twin_model_spec_uri of this DigitalTwinInstance.
Return type:	str

display_name¶

[Required] Gets the display_name of this DigitalTwinInstance. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this DigitalTwinInstance.
Return type:	str

external_key¶

Gets the external_key of this DigitalTwinInstance. 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.

Returns:	The external_key of this DigitalTwinInstance.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this DigitalTwinInstance. 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”}

Returns:	The freeform_tags of this DigitalTwinInstance.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this DigitalTwinInstance. The OCID of the resource.

Returns:	The id of this DigitalTwinInstance.
Return type:	str

iot_domain_id¶

[Required] Gets the iot_domain_id of this DigitalTwinInstance. The OCID of the IoT domain.

Returns:	The iot_domain_id of this DigitalTwinInstance.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this DigitalTwinInstance. The current state of the digital twin instance.

Allowed values for this property are: “ACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this DigitalTwinInstance.
Return type:	str

system_tags¶

Gets the system_tags of this DigitalTwinInstance. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this DigitalTwinInstance.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this DigitalTwinInstance. The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this DigitalTwinInstance.
Return type:	datetime

time_updated¶

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

Returns:	The time_updated of this DigitalTwinInstance.
Return type:	datetime