CreateDigitalTwinRelationshipDetails¶
- class oci.iot.models.CreateDigitalTwinRelationshipDetails(**kwargs)¶
Bases:
objectThe information about new digital twin relationship to be created.
Methods:
__init__(**kwargs)Initializes a new CreateDigitalTwinRelationshipDetails object with values from keyword arguments.
Attributes:
Gets the content of this CreateDigitalTwinRelationshipDetails.
[Required] Gets the content_path of this CreateDigitalTwinRelationshipDetails.
Gets the defined_tags of this CreateDigitalTwinRelationshipDetails.
Gets the description of this CreateDigitalTwinRelationshipDetails.
Gets the display_name of this CreateDigitalTwinRelationshipDetails.
Gets the freeform_tags of this CreateDigitalTwinRelationshipDetails.
[Required] Gets the iot_domain_id of this CreateDigitalTwinRelationshipDetails.
[Required] Gets the source_digital_twin_instance_id of this CreateDigitalTwinRelationshipDetails.
[Required] Gets the target_digital_twin_instance_id of this CreateDigitalTwinRelationshipDetails.
- __init__(**kwargs)¶
Initializes a new CreateDigitalTwinRelationshipDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
iot_domain_id (str) – The value to assign to the iot_domain_id property of this CreateDigitalTwinRelationshipDetails.
display_name (str) – The value to assign to the display_name property of this CreateDigitalTwinRelationshipDetails.
description (str) – The value to assign to the description property of this CreateDigitalTwinRelationshipDetails.
content_path (str) – The value to assign to the content_path property of this CreateDigitalTwinRelationshipDetails.
source_digital_twin_instance_id (str) – The value to assign to the source_digital_twin_instance_id property of this CreateDigitalTwinRelationshipDetails.
target_digital_twin_instance_id (str) – The value to assign to the target_digital_twin_instance_id property of this CreateDigitalTwinRelationshipDetails.
content (dict(str, object)) – The value to assign to the content property of this CreateDigitalTwinRelationshipDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDigitalTwinRelationshipDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDigitalTwinRelationshipDetails.
- property content¶
Gets the content of this CreateDigitalTwinRelationshipDetails. The value(s) of the relationship properties defined in the source digital twin model.
- Returns
The content of this CreateDigitalTwinRelationshipDetails.
- Return type
dict(str, object)
- property content_path¶
[Required] Gets the content_path of this CreateDigitalTwinRelationshipDetails. 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 CreateDigitalTwinRelationshipDetails.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CreateDigitalTwinRelationshipDetails. 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 CreateDigitalTwinRelationshipDetails.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this CreateDigitalTwinRelationshipDetails. A short description of the resource.
- Returns
The description of this CreateDigitalTwinRelationshipDetails.
- Return type
str
- property display_name¶
Gets the display_name of this CreateDigitalTwinRelationshipDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this CreateDigitalTwinRelationshipDetails.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CreateDigitalTwinRelationshipDetails. 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 CreateDigitalTwinRelationshipDetails.
- Return type
dict(str, str)
- property iot_domain_id¶
[Required] Gets the iot_domain_id of this CreateDigitalTwinRelationshipDetails. The OCID of the IoT domain.
- Returns
The iot_domain_id of this CreateDigitalTwinRelationshipDetails.
- Return type
str