DigitalTwinModel¶

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

Bases: object

A digital twin model, defined using Digital Twins Definition Language, specifies the schema for digital twin instance, including its components, properties, telemetry, commands, and relationships 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 DigitalTwinModel.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DigitalTwinModel.
`defined_tags`	Gets the defined_tags of this DigitalTwinModel.
`description`	Gets the description of this DigitalTwinModel.
`display_name`	[Required] Gets the display_name of this DigitalTwinModel.
`freeform_tags`	Gets the freeform_tags of this DigitalTwinModel.
`id`	[Required] Gets the id of this DigitalTwinModel.
`iot_domain_id`	[Required] Gets the iot_domain_id of this DigitalTwinModel.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DigitalTwinModel.
`spec_uri`	[Required] Gets the spec_uri of this DigitalTwinModel.
`system_tags`	Gets the system_tags of this DigitalTwinModel.
`time_created`	[Required] Gets the time_created of this DigitalTwinModel.
`time_updated`	Gets the time_updated of this DigitalTwinModel.

Methods

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

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

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

__init__(**kwargs)¶

Initializes a new DigitalTwinModel 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 DigitalTwinModel.
iot_domain_id (str) – The value to assign to the iot_domain_id property of this DigitalTwinModel.
spec_uri (str) – The value to assign to the spec_uri property of this DigitalTwinModel.
display_name (str) – The value to assign to the display_name property of this DigitalTwinModel.
description (str) – The value to assign to the description property of this DigitalTwinModel.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DigitalTwinModel. 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 DigitalTwinModel.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DigitalTwinModel.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DigitalTwinModel.
time_created (datetime) – The value to assign to the time_created property of this DigitalTwinModel.
time_updated (datetime) – The value to assign to the time_updated property of this DigitalTwinModel.

defined_tags¶

Gets the defined_tags of this DigitalTwinModel. 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 DigitalTwinModel.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this DigitalTwinModel. A short description of the resource. If left blank, the description will be derived from the spec.

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

display_name¶

[Required] Gets the display_name of this DigitalTwinModel. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information. If left blank, the display name will be derived from the spec.

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

freeform_tags¶

Gets the freeform_tags of this DigitalTwinModel. 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 DigitalTwinModel.
Return type:	dict(str, str)

id¶

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

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

iot_domain_id¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this DigitalTwinModel. The current state of the digital twin model.

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 DigitalTwinModel.
Return type:	str

spec_uri¶

[Required] Gets the spec_uri of this DigitalTwinModel. This is the DTMI (Digital Twin Model Identifier) of the digital twin model as defined in DTDL specification.

Returns:	The spec_uri of this DigitalTwinModel.
Return type:	str

system_tags¶

Gets the system_tags of this DigitalTwinModel. 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 DigitalTwinModel.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this DigitalTwinModel. 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 DigitalTwinModel.
Return type:	datetime

time_updated¶

Gets the time_updated of this DigitalTwinModel. 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 DigitalTwinModel.
Return type:	datetime