DigitalTwinRelationship¶
- class oci.iot.models.DigitalTwinRelationship(**kwargs)¶
Bases:
objectA digital twin relationship represents an association between two digital twin instances. It can include properties to describe the nature and context of the association 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:
A constant which can be used with the lifecycle_state property of a DigitalTwinRelationship.
A constant which can be used with the lifecycle_state property of a DigitalTwinRelationship.
Gets the content of this DigitalTwinRelationship.
[Required] Gets the content_path of this DigitalTwinRelationship.
Gets the defined_tags of this DigitalTwinRelationship.
Gets the description of this DigitalTwinRelationship.
[Required] Gets the display_name of this DigitalTwinRelationship.
Gets the freeform_tags of this DigitalTwinRelationship.
[Required] Gets the id of this DigitalTwinRelationship.
[Required] Gets the iot_domain_id of this DigitalTwinRelationship.
[Required] Gets the lifecycle_state of this DigitalTwinRelationship.
[Required] Gets the source_digital_twin_instance_id of this DigitalTwinRelationship.
Gets the system_tags of this DigitalTwinRelationship.
[Required] Gets the target_digital_twin_instance_id of this DigitalTwinRelationship.
[Required] Gets the time_created of this DigitalTwinRelationship.
Gets the time_updated of this DigitalTwinRelationship.
Methods:
__init__(**kwargs)Initializes a new DigitalTwinRelationship object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a DigitalTwinRelationship. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a DigitalTwinRelationship. This constant has a value of “DELETED”
- __init__(**kwargs)¶
Initializes a new DigitalTwinRelationship 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 DigitalTwinRelationship.
iot_domain_id (str) – The value to assign to the iot_domain_id property of this DigitalTwinRelationship.
display_name (str) – The value to assign to the display_name property of this DigitalTwinRelationship.
description (str) – The value to assign to the description property of this DigitalTwinRelationship.
content_path (str) – The value to assign to the content_path property of this DigitalTwinRelationship.
source_digital_twin_instance_id (str) – The value to assign to the source_digital_twin_instance_id property of this DigitalTwinRelationship.
target_digital_twin_instance_id (str) – The value to assign to the target_digital_twin_instance_id property of this DigitalTwinRelationship.
content (dict(str, object)) – The value to assign to the content property of this DigitalTwinRelationship.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DigitalTwinRelationship. 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 DigitalTwinRelationship.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DigitalTwinRelationship.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DigitalTwinRelationship.
time_created (datetime) – The value to assign to the time_created property of this DigitalTwinRelationship.
time_updated (datetime) – The value to assign to the time_updated property of this DigitalTwinRelationship.
- property content¶
Gets the content of this DigitalTwinRelationship. The value(s) of the relationship properties defined in the source digital twin model.
- Returns
The content of this DigitalTwinRelationship.
- Return type
dict(str, object)
- property content_path¶
[Required] Gets the content_path of this DigitalTwinRelationship. Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model.
- Returns
The content_path of this DigitalTwinRelationship.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this DigitalTwinRelationship. 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 DigitalTwinRelationship.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this DigitalTwinRelationship. A short description of the resource.
- Returns
The description of this DigitalTwinRelationship.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this DigitalTwinRelationship. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this DigitalTwinRelationship.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this DigitalTwinRelationship. 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 DigitalTwinRelationship.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this DigitalTwinRelationship. The OCID of the resource.
- Returns
The id of this DigitalTwinRelationship.
- Return type
str
- property iot_domain_id¶
[Required] Gets the iot_domain_id of this DigitalTwinRelationship. The OCID of the IoT domain.
- Returns
The iot_domain_id of this DigitalTwinRelationship.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this DigitalTwinRelationship. The current state of the digital twin relationship.
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 DigitalTwinRelationship.
- Return type
str
- property source_digital_twin_instance_id¶
[Required] Gets the source_digital_twin_instance_id of this DigitalTwinRelationship. The OCID of source digital twin instance.
- Returns
The source_digital_twin_instance_id of this DigitalTwinRelationship.
- Return type
str
- property system_tags¶
Gets the system_tags of this DigitalTwinRelationship. 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 DigitalTwinRelationship.
- Return type
dict(str, dict(str, object))
- property target_digital_twin_instance_id¶
[Required] Gets the target_digital_twin_instance_id of this DigitalTwinRelationship. The OCID of target digital twin instance.
- Returns
The target_digital_twin_instance_id of this DigitalTwinRelationship.
- Return type
str