DigitalTwinRelationshipSummary

class oci.iot.models.DigitalTwinRelationshipSummary(**kwargs)

Bases: object

Describes digital twin relationship summary

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a DigitalTwinRelationshipSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a DigitalTwinRelationshipSummary.

content_path

[Required] Gets the content_path of this DigitalTwinRelationshipSummary.

defined_tags

Gets the defined_tags of this DigitalTwinRelationshipSummary.

description

Gets the description of this DigitalTwinRelationshipSummary.

display_name

[Required] Gets the display_name of this DigitalTwinRelationshipSummary.

freeform_tags

Gets the freeform_tags of this DigitalTwinRelationshipSummary.

id

[Required] Gets the id of this DigitalTwinRelationshipSummary.

iot_domain_id

[Required] Gets the iot_domain_id of this DigitalTwinRelationshipSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this DigitalTwinRelationshipSummary.

source_digital_twin_instance_id

[Required] Gets the source_digital_twin_instance_id of this DigitalTwinRelationshipSummary.

system_tags

Gets the system_tags of this DigitalTwinRelationshipSummary.

target_digital_twin_instance_id

[Required] Gets the target_digital_twin_instance_id of this DigitalTwinRelationshipSummary.

time_created

[Required] Gets the time_created of this DigitalTwinRelationshipSummary.

time_updated

Gets the time_updated of this DigitalTwinRelationshipSummary.

Methods:

__init__(**kwargs)

Initializes a new DigitalTwinRelationshipSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a DigitalTwinRelationshipSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a DigitalTwinRelationshipSummary. This constant has a value of “DELETED”

__init__(**kwargs)

Initializes a new DigitalTwinRelationshipSummary 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 DigitalTwinRelationshipSummary.

  • iot_domain_id (str) – The value to assign to the iot_domain_id property of this DigitalTwinRelationshipSummary.

  • display_name (str) – The value to assign to the display_name property of this DigitalTwinRelationshipSummary.

  • description (str) – The value to assign to the description property of this DigitalTwinRelationshipSummary.

  • content_path (str) – The value to assign to the content_path property of this DigitalTwinRelationshipSummary.

  • source_digital_twin_instance_id (str) – The value to assign to the source_digital_twin_instance_id property of this DigitalTwinRelationshipSummary.

  • target_digital_twin_instance_id (str) – The value to assign to the target_digital_twin_instance_id property of this DigitalTwinRelationshipSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DigitalTwinRelationshipSummary. 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 DigitalTwinRelationshipSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DigitalTwinRelationshipSummary.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DigitalTwinRelationshipSummary.

  • time_created (datetime) – The value to assign to the time_created property of this DigitalTwinRelationshipSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this DigitalTwinRelationshipSummary.

property content_path

[Required] Gets the content_path of this DigitalTwinRelationshipSummary. 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 DigitalTwinRelationshipSummary.

Return type

str

property defined_tags

Gets the defined_tags of this DigitalTwinRelationshipSummary. 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 DigitalTwinRelationshipSummary.

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this DigitalTwinRelationshipSummary.

Return type

str

property display_name

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

Returns

The display_name of this DigitalTwinRelationshipSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this DigitalTwinRelationshipSummary. 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 DigitalTwinRelationshipSummary.

Return type

dict(str, str)

property id

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

Returns

The id of this DigitalTwinRelationshipSummary.

Return type

str

property iot_domain_id

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

Returns

The iot_domain_id of this DigitalTwinRelationshipSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this DigitalTwinRelationshipSummary. 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 DigitalTwinRelationshipSummary.

Return type

str

property source_digital_twin_instance_id

[Required] Gets the source_digital_twin_instance_id of this DigitalTwinRelationshipSummary. The OCID of source digital twin instance.

Returns

The source_digital_twin_instance_id of this DigitalTwinRelationshipSummary.

Return type

str

property system_tags

Gets the system_tags of this DigitalTwinRelationshipSummary. 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 DigitalTwinRelationshipSummary.

Return type

dict(str, dict(str, object))

property target_digital_twin_instance_id

[Required] Gets the target_digital_twin_instance_id of this DigitalTwinRelationshipSummary. The OCID of target digital twin instance.

Returns

The target_digital_twin_instance_id of this DigitalTwinRelationshipSummary.

Return type

str

property time_created

[Required] Gets the time_created of this DigitalTwinRelationshipSummary. 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 DigitalTwinRelationshipSummary.

Return type

datetime

property time_updated

Gets the time_updated of this DigitalTwinRelationshipSummary. 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 DigitalTwinRelationshipSummary.

Return type

datetime