DigitalTwinInstanceSummary¶
- class oci.iot.models.DigitalTwinInstanceSummary(**kwargs)¶
Bases:
objectSummary of the digital twin instance
Attributes:
A constant which can be used with the connectivity_type property of a DigitalTwinInstanceSummary.
A constant which can be used with the connectivity_type property of a DigitalTwinInstanceSummary.
A constant which can be used with the connectivity_type property of a DigitalTwinInstanceSummary.
A constant which can be used with the connectivity_type property of a DigitalTwinInstanceSummary.
A constant which can be used with the lifecycle_state property of a DigitalTwinInstanceSummary.
A constant which can be used with the lifecycle_state property of a DigitalTwinInstanceSummary.
Gets the auth_id of this DigitalTwinInstanceSummary.
[Required] Gets the connectivity_type of this DigitalTwinInstanceSummary.
Gets the defined_tags of this DigitalTwinInstanceSummary.
Gets the description of this DigitalTwinInstanceSummary.
Gets the digital_twin_adapter_id of this DigitalTwinInstanceSummary.
Gets the digital_twin_model_id of this DigitalTwinInstanceSummary.
Gets the digital_twin_model_spec_uri of this DigitalTwinInstanceSummary.
[Required] Gets the display_name of this DigitalTwinInstanceSummary.
Gets the external_key of this DigitalTwinInstanceSummary.
Gets the freeform_tags of this DigitalTwinInstanceSummary.
Gets the gateways of this DigitalTwinInstanceSummary.
[Required] Gets the id of this DigitalTwinInstanceSummary.
[Required] Gets the iot_domain_id of this DigitalTwinInstanceSummary.
[Required] Gets the lifecycle_state of this DigitalTwinInstanceSummary.
Gets the system_tags of this DigitalTwinInstanceSummary.
[Required] Gets the time_created of this DigitalTwinInstanceSummary.
Gets the time_updated of this DigitalTwinInstanceSummary.
Methods:
__init__(**kwargs)Initializes a new DigitalTwinInstanceSummary object with values from keyword arguments.
- CONNECTIVITY_TYPE_DIRECT = 'DIRECT'¶
A constant which can be used with the connectivity_type property of a DigitalTwinInstanceSummary. This constant has a value of “DIRECT”
- CONNECTIVITY_TYPE_GATEWAY = 'GATEWAY'¶
A constant which can be used with the connectivity_type property of a DigitalTwinInstanceSummary. This constant has a value of “GATEWAY”
- CONNECTIVITY_TYPE_INDIRECT = 'INDIRECT'¶
A constant which can be used with the connectivity_type property of a DigitalTwinInstanceSummary. This constant has a value of “INDIRECT”
- CONNECTIVITY_TYPE_NONE = 'NONE'¶
A constant which can be used with the connectivity_type property of a DigitalTwinInstanceSummary. This constant has a value of “NONE”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a DigitalTwinInstanceSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a DigitalTwinInstanceSummary. This constant has a value of “DELETED”
- __init__(**kwargs)¶
Initializes a new DigitalTwinInstanceSummary 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 DigitalTwinInstanceSummary.
iot_domain_id (str) – The value to assign to the iot_domain_id property of this DigitalTwinInstanceSummary.
connectivity_type (str) – The value to assign to the connectivity_type property of this DigitalTwinInstanceSummary. Allowed values for this property are: “DIRECT”, “INDIRECT”, “GATEWAY”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
auth_id (str) – The value to assign to the auth_id property of this DigitalTwinInstanceSummary.
external_key (str) – The value to assign to the external_key property of this DigitalTwinInstanceSummary.
display_name (str) – The value to assign to the display_name property of this DigitalTwinInstanceSummary.
description (str) – The value to assign to the description property of this DigitalTwinInstanceSummary.
digital_twin_model_id (str) – The value to assign to the digital_twin_model_id property of this DigitalTwinInstanceSummary.
digital_twin_model_spec_uri (str) – The value to assign to the digital_twin_model_spec_uri property of this DigitalTwinInstanceSummary.
digital_twin_adapter_id (str) – The value to assign to the digital_twin_adapter_id property of this DigitalTwinInstanceSummary.
gateways (list[str]) – The value to assign to the gateways property of this DigitalTwinInstanceSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DigitalTwinInstanceSummary. 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 DigitalTwinInstanceSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DigitalTwinInstanceSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DigitalTwinInstanceSummary.
time_created (datetime) – The value to assign to the time_created property of this DigitalTwinInstanceSummary.
time_updated (datetime) – The value to assign to the time_updated property of this DigitalTwinInstanceSummary.
- property auth_id¶
Gets the auth_id of this DigitalTwinInstanceSummary. The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
- Returns
The auth_id of this DigitalTwinInstanceSummary.
- Return type
str
- property connectivity_type¶
[Required] Gets the connectivity_type of this DigitalTwinInstanceSummary. Connectivity type of the digital twin instance.
Allowed values for this property are: “DIRECT”, “INDIRECT”, “GATEWAY”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The connectivity_type of this DigitalTwinInstanceSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this DigitalTwinInstanceSummary. 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 DigitalTwinInstanceSummary.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this DigitalTwinInstanceSummary. A short description of the resource.
- Returns
The description of this DigitalTwinInstanceSummary.
- Return type
str
- property digital_twin_adapter_id¶
Gets the digital_twin_adapter_id of this DigitalTwinInstanceSummary. The OCID of the digital twin adapter.
- Returns
The digital_twin_adapter_id of this DigitalTwinInstanceSummary.
- Return type
str
- property digital_twin_model_id¶
Gets the digital_twin_model_id of this DigitalTwinInstanceSummary. The OCID of the digital twin model.
- Returns
The digital_twin_model_id of this DigitalTwinInstanceSummary.
- Return type
str
- property digital_twin_model_spec_uri¶
Gets the digital_twin_model_spec_uri of this DigitalTwinInstanceSummary. The URI of the digital twin model specification.
- Returns
The digital_twin_model_spec_uri of this DigitalTwinInstanceSummary.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this DigitalTwinInstanceSummary. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this DigitalTwinInstanceSummary.
- Return type
str
- property external_key¶
Gets the external_key of this DigitalTwinInstanceSummary. A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance. This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case. If not provided, the system will automatically generate one.
- Returns
The external_key of this DigitalTwinInstanceSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this DigitalTwinInstanceSummary. 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 DigitalTwinInstanceSummary.
- Return type
dict(str, str)
- property gateways¶
Gets the gateways of this DigitalTwinInstanceSummary. An array of unique ids (OCIDs) of the IoT digital twin instances with connectivityType equals to GATEWAY.
- Returns
The gateways of this DigitalTwinInstanceSummary.
- Return type
list[str]
- property id¶
[Required] Gets the id of this DigitalTwinInstanceSummary. The OCID of the resource.
- Returns
The id of this DigitalTwinInstanceSummary.
- Return type
str
- property iot_domain_id¶
[Required] Gets the iot_domain_id of this DigitalTwinInstanceSummary. The OCID of the IoT domain.
- Returns
The iot_domain_id of this DigitalTwinInstanceSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this DigitalTwinInstanceSummary. The current state of the digital twin instance.
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 DigitalTwinInstanceSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this DigitalTwinInstanceSummary. 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 DigitalTwinInstanceSummary.
- Return type
dict(str, dict(str, object))