DigitalTwinAdapter¶
- class oci.iot.models.DigitalTwinAdapter(**kwargs)¶
Bases:
objectThe digital twin adapter maps incoming data from IoT device into the corresponding digital twin instance. It defines the envelope structure, reference payload, routing and transformation rules using JSON Path and JQ to normalize the raw device data 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 DigitalTwinAdapter.
A constant which can be used with the lifecycle_state property of a DigitalTwinAdapter.
Gets the defined_tags of this DigitalTwinAdapter.
Gets the description of this DigitalTwinAdapter.
[Required] Gets the digital_twin_model_id of this DigitalTwinAdapter.
[Required] Gets the digital_twin_model_spec_uri of this DigitalTwinAdapter.
[Required] Gets the display_name of this DigitalTwinAdapter.
Gets the freeform_tags of this DigitalTwinAdapter.
[Required] Gets the id of this DigitalTwinAdapter.
Gets the inbound_envelope of this DigitalTwinAdapter.
Gets the inbound_routes of this DigitalTwinAdapter.
[Required] Gets the iot_domain_id of this DigitalTwinAdapter.
[Required] Gets the lifecycle_state of this DigitalTwinAdapter.
Gets the system_tags of this DigitalTwinAdapter.
[Required] Gets the time_created of this DigitalTwinAdapter.
Gets the time_updated of this DigitalTwinAdapter.
Methods:
__init__(**kwargs)Initializes a new DigitalTwinAdapter object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a DigitalTwinAdapter. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a DigitalTwinAdapter. This constant has a value of “DELETED”
- __init__(**kwargs)¶
Initializes a new DigitalTwinAdapter 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 DigitalTwinAdapter.
iot_domain_id (str) – The value to assign to the iot_domain_id property of this DigitalTwinAdapter.
digital_twin_model_id (str) – The value to assign to the digital_twin_model_id property of this DigitalTwinAdapter.
digital_twin_model_spec_uri (str) – The value to assign to the digital_twin_model_spec_uri property of this DigitalTwinAdapter.
display_name (str) – The value to assign to the display_name property of this DigitalTwinAdapter.
description (str) – The value to assign to the description property of this DigitalTwinAdapter.
inbound_envelope (oci.iot.models.DigitalTwinAdapterInboundEnvelope) – The value to assign to the inbound_envelope property of this DigitalTwinAdapter.
inbound_routes (list[oci.iot.models.DigitalTwinAdapterInboundRoute]) – The value to assign to the inbound_routes property of this DigitalTwinAdapter.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DigitalTwinAdapter. 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 DigitalTwinAdapter.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DigitalTwinAdapter.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DigitalTwinAdapter.
time_created (datetime) – The value to assign to the time_created property of this DigitalTwinAdapter.
time_updated (datetime) – The value to assign to the time_updated property of this DigitalTwinAdapter.
- property defined_tags¶
Gets the defined_tags of this DigitalTwinAdapter. 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 DigitalTwinAdapter.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this DigitalTwinAdapter. A short description of the resource.
- Returns
The description of this DigitalTwinAdapter.
- Return type
str
- property digital_twin_model_id¶
[Required] Gets the digital_twin_model_id of this DigitalTwinAdapter. The OCID of the digital twin model.
- Returns
The digital_twin_model_id of this DigitalTwinAdapter.
- Return type
str
- property digital_twin_model_spec_uri¶
[Required] Gets the digital_twin_model_spec_uri of this DigitalTwinAdapter. The URI of the digital twin model specification.
- Returns
The digital_twin_model_spec_uri of this DigitalTwinAdapter.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this DigitalTwinAdapter. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this DigitalTwinAdapter.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this DigitalTwinAdapter. 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 DigitalTwinAdapter.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this DigitalTwinAdapter. The OCID of the resource.
- Returns
The id of this DigitalTwinAdapter.
- Return type
str
- property inbound_envelope¶
Gets the inbound_envelope of this DigitalTwinAdapter.
- Returns
The inbound_envelope of this DigitalTwinAdapter.
- Return type
- property inbound_routes¶
Gets the inbound_routes of this DigitalTwinAdapter. list of routes
- Returns
The inbound_routes of this DigitalTwinAdapter.
- Return type
- property iot_domain_id¶
[Required] Gets the iot_domain_id of this DigitalTwinAdapter. The OCID of the IoT domain.
- Returns
The iot_domain_id of this DigitalTwinAdapter.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this DigitalTwinAdapter. The current state of the digital twin adapter.
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 DigitalTwinAdapter.
- Return type
str
- property system_tags¶
Gets the system_tags of this DigitalTwinAdapter. 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 DigitalTwinAdapter.
- Return type
dict(str, dict(str, object))