File manager

File manager - Edit - /usr/lib/mysqlsh/lib/python3.9/site-packages/oci/iot/models/digital_twin_adapter.py

Back
# coding: utf-8 # Copyright (c) 2016, 2026, Oracle and/or its affiliates. All rights reserved. # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. # NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20250531 from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 from oci.decorators import init_model_state_from_kwargs @init_model_state_from_kwargs class DigitalTwinAdapter(object): """ The 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`__. __ https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm """ #: A constant which can be used with the lifecycle_state property of a DigitalTwinAdapter. #: This constant has a value of "ACTIVE" LIFECYCLE_STATE_ACTIVE = "ACTIVE" #: A constant which can be used with the lifecycle_state property of a DigitalTwinAdapter. #: This constant has a value of "DELETED" LIFECYCLE_STATE_DELETED = "DELETED" def __init__(self, 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): :param id: The value to assign to the id property of this DigitalTwinAdapter. :type id: str :param iot_domain_id: The value to assign to the iot_domain_id property of this DigitalTwinAdapter. :type iot_domain_id: str :param digital_twin_model_id: The value to assign to the digital_twin_model_id property of this DigitalTwinAdapter. :type digital_twin_model_id: str :param digital_twin_model_spec_uri: The value to assign to the digital_twin_model_spec_uri property of this DigitalTwinAdapter. :type digital_twin_model_spec_uri: str :param display_name: The value to assign to the display_name property of this DigitalTwinAdapter. :type display_name: str :param description: The value to assign to the description property of this DigitalTwinAdapter. :type description: str :param inbound_envelope: The value to assign to the inbound_envelope property of this DigitalTwinAdapter. :type inbound_envelope: oci.iot.models.DigitalTwinAdapterInboundEnvelope :param inbound_routes: The value to assign to the inbound_routes property of this DigitalTwinAdapter. :type inbound_routes: list[oci.iot.models.DigitalTwinAdapterInboundRoute] :param lifecycle_state: 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'. :type lifecycle_state: str :param freeform_tags: The value to assign to the freeform_tags property of this DigitalTwinAdapter. :type freeform_tags: dict(str, str) :param defined_tags: The value to assign to the defined_tags property of this DigitalTwinAdapter. :type defined_tags: dict(str, dict(str, object)) :param system_tags: The value to assign to the system_tags property of this DigitalTwinAdapter. :type system_tags: dict(str, dict(str, object)) :param time_created: The value to assign to the time_created property of this DigitalTwinAdapter. :type time_created: datetime :param time_updated: The value to assign to the time_updated property of this DigitalTwinAdapter. :type time_updated: datetime """ self.swagger_types = { 'id': 'str', 'iot_domain_id': 'str', 'digital_twin_model_id': 'str', 'digital_twin_model_spec_uri': 'str', 'display_name': 'str', 'description': 'str', 'inbound_envelope': 'DigitalTwinAdapterInboundEnvelope', 'inbound_routes': 'list[DigitalTwinAdapterInboundRoute]', 'lifecycle_state': 'str', 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))', 'system_tags': 'dict(str, dict(str, object))', 'time_created': 'datetime', 'time_updated': 'datetime' } self.attribute_map = { 'id': 'id', 'iot_domain_id': 'iotDomainId', 'digital_twin_model_id': 'digitalTwinModelId', 'digital_twin_model_spec_uri': 'digitalTwinModelSpecUri', 'display_name': 'displayName', 'description': 'description', 'inbound_envelope': 'inboundEnvelope', 'inbound_routes': 'inboundRoutes', 'lifecycle_state': 'lifecycleState', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags', 'system_tags': 'systemTags', 'time_created': 'timeCreated', 'time_updated': 'timeUpdated' } self._id = None self._iot_domain_id = None self._digital_twin_model_id = None self._digital_twin_model_spec_uri = None self._display_name = None self._description = None self._inbound_envelope = None self._inbound_routes = None self._lifecycle_state = None self._freeform_tags = None self._defined_tags = None self._system_tags = None self._time_created = None self._time_updated = None @property def id(self): """ [Required] Gets the id of this DigitalTwinAdapter. The `OCID`__ of the resource. __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The id of this DigitalTwinAdapter. :rtype: str """ return self._id @id.setter def id(self, id): """ Sets the id of this DigitalTwinAdapter. The `OCID`__ of the resource. __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param id: The id of this DigitalTwinAdapter. :type: str """ self._id = id @property def iot_domain_id(self): """ [Required] Gets the iot_domain_id of this DigitalTwinAdapter. The `OCID`__ of the IoT domain. __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The iot_domain_id of this DigitalTwinAdapter. :rtype: str """ return self._iot_domain_id @iot_domain_id.setter def iot_domain_id(self, iot_domain_id): """ Sets the iot_domain_id of this DigitalTwinAdapter. The `OCID`__ of the IoT domain. __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param iot_domain_id: The iot_domain_id of this DigitalTwinAdapter. :type: str """ self._iot_domain_id = iot_domain_id @property def digital_twin_model_id(self): """ [Required] Gets the digital_twin_model_id of this DigitalTwinAdapter. The `OCID`__ of the digital twin model. __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The digital_twin_model_id of this DigitalTwinAdapter. :rtype: str """ return self._digital_twin_model_id @digital_twin_model_id.setter def digital_twin_model_id(self, digital_twin_model_id): """ Sets the digital_twin_model_id of this DigitalTwinAdapter. The `OCID`__ of the digital twin model. __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param digital_twin_model_id: The digital_twin_model_id of this DigitalTwinAdapter. :type: str """ self._digital_twin_model_id = digital_twin_model_id @property def digital_twin_model_spec_uri(self): """ [Required] Gets the digital_twin_model_spec_uri of this DigitalTwinAdapter. The URI of the digital twin model specification. :return: The digital_twin_model_spec_uri of this DigitalTwinAdapter. :rtype: str """ return self._digital_twin_model_spec_uri @digital_twin_model_spec_uri.setter def digital_twin_model_spec_uri(self, digital_twin_model_spec_uri): """ Sets the digital_twin_model_spec_uri of this DigitalTwinAdapter. The URI of the digital twin model specification. :param digital_twin_model_spec_uri: The digital_twin_model_spec_uri of this DigitalTwinAdapter. :type: str """ self._digital_twin_model_spec_uri = digital_twin_model_spec_uri @property def display_name(self): """ [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. :return: The display_name of this DigitalTwinAdapter. :rtype: str """ return self._display_name @display_name.setter def display_name(self, display_name): """ Sets the display_name of this DigitalTwinAdapter. A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. :param display_name: The display_name of this DigitalTwinAdapter. :type: str """ self._display_name = display_name @property def description(self): """ Gets the description of this DigitalTwinAdapter. A short description of the resource. :return: The description of this DigitalTwinAdapter. :rtype: str """ return self._description @description.setter def description(self, description): """ Sets the description of this DigitalTwinAdapter. A short description of the resource. :param description: The description of this DigitalTwinAdapter. :type: str """ self._description = description @property def inbound_envelope(self): """ Gets the inbound_envelope of this DigitalTwinAdapter. :return: The inbound_envelope of this DigitalTwinAdapter. :rtype: oci.iot.models.DigitalTwinAdapterInboundEnvelope """ return self._inbound_envelope @inbound_envelope.setter def inbound_envelope(self, inbound_envelope): """ Sets the inbound_envelope of this DigitalTwinAdapter. :param inbound_envelope: The inbound_envelope of this DigitalTwinAdapter. :type: oci.iot.models.DigitalTwinAdapterInboundEnvelope """ self._inbound_envelope = inbound_envelope @property def inbound_routes(self): """ Gets the inbound_routes of this DigitalTwinAdapter. list of routes :return: The inbound_routes of this DigitalTwinAdapter. :rtype: list[oci.iot.models.DigitalTwinAdapterInboundRoute] """ return self._inbound_routes @inbound_routes.setter def inbound_routes(self, inbound_routes): """ Sets the inbound_routes of this DigitalTwinAdapter. list of routes :param inbound_routes: The inbound_routes of this DigitalTwinAdapter. :type: list[oci.iot.models.DigitalTwinAdapterInboundRoute] """ self._inbound_routes = inbound_routes @property def lifecycle_state(self): """ [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'. :return: The lifecycle_state of this DigitalTwinAdapter. :rtype: str """ return self._lifecycle_state @lifecycle_state.setter def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this DigitalTwinAdapter. The current state of the digital twin adapter. :param lifecycle_state: The lifecycle_state of this DigitalTwinAdapter. :type: str """ allowed_values = ["ACTIVE", "DELETED"] if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state @property def freeform_tags(self): """ 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\"}` __ https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm :return: The freeform_tags of this DigitalTwinAdapter. :rtype: dict(str, str) """ return self._freeform_tags @freeform_tags.setter def freeform_tags(self, freeform_tags): """ Sets 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\"}` __ https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm :param freeform_tags: The freeform_tags of this DigitalTwinAdapter. :type: dict(str, str) """ self._freeform_tags = freeform_tags @property def defined_tags(self): """ 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\"}}` __ https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm :return: The defined_tags of this DigitalTwinAdapter. :rtype: dict(str, dict(str, object)) """ return self._defined_tags @defined_tags.setter def defined_tags(self, defined_tags): """ Sets 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\"}}` __ https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm :param defined_tags: The defined_tags of this DigitalTwinAdapter. :type: dict(str, dict(str, object)) """ self._defined_tags = defined_tags @property def system_tags(self): """ 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\"}}` :return: The system_tags of this DigitalTwinAdapter. :rtype: dict(str, dict(str, object)) """ return self._system_tags @system_tags.setter def system_tags(self, system_tags): """ Sets 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\"}}` :param system_tags: The system_tags of this DigitalTwinAdapter. :type: dict(str, dict(str, object)) """ self._system_tags = system_tags @property def time_created(self): """ [Required]** Gets the time_created of this DigitalTwinAdapter. The date and time when the resource was created, in the format defined by `RFC 3339`__. Example: `2016-08-25T21:10:29.600Z` __ https://tools.ietf.org/html/rfc3339 :return: The time_created of this DigitalTwinAdapter. :rtype: datetime """ return self._time_created @time_created.setter def time_created(self, time_created): """ Sets the time_created of this DigitalTwinAdapter. The date and time when the resource was created, in the format defined by `RFC 3339`__. Example: `2016-08-25T21:10:29.600Z` __ https://tools.ietf.org/html/rfc3339 :param time_created: The time_created of this DigitalTwinAdapter. :type: datetime """ self._time_created = time_created @property def time_updated(self): """ Gets the time_updated of this DigitalTwinAdapter. The date and time when the resource was last updated, in the format defined by `RFC 3339`__. Example: `2016-08-25T21:10:29.600Z` __ https://tools.ietf.org/html/rfc3339 :return: The time_updated of this DigitalTwinAdapter. :rtype: datetime """ return self._time_updated @time_updated.setter def time_updated(self, time_updated): """ Sets the time_updated of this DigitalTwinAdapter. The date and time when the resource was last updated, in the format defined by `RFC 3339`__. Example: `2016-08-25T21:10:29.600Z` __ https://tools.ietf.org/html/rfc3339 :param time_updated: The time_updated of this DigitalTwinAdapter. :type: datetime """ self._time_updated = time_updated def __repr__(self): return formatted_flat_dict(self) def __eq__(self, other): if other is None: return False return self.__dict__ == other.__dict__ def __ne__(self, other): return not self == other

| ver. 1.4 | Github | . | PHP 8.2.32 | Generation time: 0.06 | proxy | phpinfo | Settings