DigitalTwinModelSummary¶

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

Bases: object

Summary of the digital twin model.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DigitalTwinModelSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DigitalTwinModelSummary.
`defined_tags`	Gets the defined_tags of this DigitalTwinModelSummary.
`description`	Gets the description of this DigitalTwinModelSummary.
`display_name`	[Required] Gets the display_name of this DigitalTwinModelSummary.
`freeform_tags`	Gets the freeform_tags of this DigitalTwinModelSummary.
`id`	[Required] Gets the id of this DigitalTwinModelSummary.
`iot_domain_id`	[Required] Gets the iot_domain_id of this DigitalTwinModelSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DigitalTwinModelSummary.
`spec_uri`	[Required] Gets the spec_uri of this DigitalTwinModelSummary.
`system_tags`	Gets the system_tags of this DigitalTwinModelSummary.
`time_created`	[Required] Gets the time_created of this DigitalTwinModelSummary.
`time_updated`	Gets the time_updated of this DigitalTwinModelSummary.

Methods

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

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

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

__init__(**kwargs)¶

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

defined_tags¶

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

description¶

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

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

display_name¶

[Required] Gets the display_name of this DigitalTwinModelSummary. 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 DigitalTwinModelSummary.
Return type:	str

freeform_tags¶

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

id¶

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

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

iot_domain_id¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this DigitalTwinModelSummary. 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 DigitalTwinModelSummary.
Return type:	str

spec_uri¶

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

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

system_tags¶

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

time_created¶

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

time_updated¶

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