File manager

File manager - Edit - /usr/lib/mysqlsh/lib/python3.9/site-packages/oci/iot/models/iot_domain.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 IotDomain(object): """ An IoT domain is an Oracle Cloud Infrastructure resource that provides a managed environment for organizing and managing digital twin resources, such as models, adapters, instances and relationships, within a compartment and IoT domain group. 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 IotDomain. #: This constant has a value of "CREATING" LIFECYCLE_STATE_CREATING = "CREATING" #: A constant which can be used with the lifecycle_state property of a IotDomain. #: This constant has a value of "UPDATING" LIFECYCLE_STATE_UPDATING = "UPDATING" #: A constant which can be used with the lifecycle_state property of a IotDomain. #: This constant has a value of "ACTIVE" LIFECYCLE_STATE_ACTIVE = "ACTIVE" #: A constant which can be used with the lifecycle_state property of a IotDomain. #: This constant has a value of "DELETING" LIFECYCLE_STATE_DELETING = "DELETING" #: A constant which can be used with the lifecycle_state property of a IotDomain. #: This constant has a value of "DELETED" LIFECYCLE_STATE_DELETED = "DELETED" #: A constant which can be used with the lifecycle_state property of a IotDomain. #: This constant has a value of "FAILED" LIFECYCLE_STATE_FAILED = "FAILED" def __init__(self, kwargs): """ Initializes a new IotDomain 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 IotDomain. :type id: str :param iot_domain_group_id: The value to assign to the iot_domain_group_id property of this IotDomain. :type iot_domain_group_id: str :param compartment_id: The value to assign to the compartment_id property of this IotDomain. :type compartment_id: str :param display_name: The value to assign to the display_name property of this IotDomain. :type display_name: str :param description: The value to assign to the description property of this IotDomain. :type description: str :param device_host: The value to assign to the device_host property of this IotDomain. :type device_host: str :param db_allow_listed_identity_group_names: The value to assign to the db_allow_listed_identity_group_names property of this IotDomain. :type db_allow_listed_identity_group_names: list[str] :param db_allowed_identity_domain_host: The value to assign to the db_allowed_identity_domain_host property of this IotDomain. :type db_allowed_identity_domain_host: str :param data_retention_periods_in_days: The value to assign to the data_retention_periods_in_days property of this IotDomain. :type data_retention_periods_in_days: oci.iot.models.DataRetentionPeriodsInDays :param lifecycle_state: The value to assign to the lifecycle_state property of this IotDomain. Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", '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 IotDomain. :type freeform_tags: dict(str, str) :param defined_tags: The value to assign to the defined_tags property of this IotDomain. :type defined_tags: dict(str, dict(str, object)) :param system_tags: The value to assign to the system_tags property of this IotDomain. :type system_tags: dict(str, dict(str, object)) :param time_created: The value to assign to the time_created property of this IotDomain. :type time_created: datetime :param time_updated: The value to assign to the time_updated property of this IotDomain. :type time_updated: datetime """ self.swagger_types = { 'id': 'str', 'iot_domain_group_id': 'str', 'compartment_id': 'str', 'display_name': 'str', 'description': 'str', 'device_host': 'str', 'db_allow_listed_identity_group_names': 'list[str]', 'db_allowed_identity_domain_host': 'str', 'data_retention_periods_in_days': 'DataRetentionPeriodsInDays', '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_group_id': 'iotDomainGroupId', 'compartment_id': 'compartmentId', 'display_name': 'displayName', 'description': 'description', 'device_host': 'deviceHost', 'db_allow_listed_identity_group_names': 'dbAllowListedIdentityGroupNames', 'db_allowed_identity_domain_host': 'dbAllowedIdentityDomainHost', 'data_retention_periods_in_days': 'dataRetentionPeriodsInDays', 'lifecycle_state': 'lifecycleState', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags', 'system_tags': 'systemTags', 'time_created': 'timeCreated', 'time_updated': 'timeUpdated' } self._id = None self._iot_domain_group_id = None self._compartment_id = None self._display_name = None self._description = None self._device_host = None self._db_allow_listed_identity_group_names = None self._db_allowed_identity_domain_host = None self._data_retention_periods_in_days = 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 IotDomain. The `OCID`__ of the resource. __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The id of this IotDomain. :rtype: str """ return self._id @id.setter def id(self, id): """ Sets the id of this IotDomain. The `OCID`__ of the resource. __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param id: The id of this IotDomain. :type: str """ self._id = id @property def iot_domain_group_id(self): """ [Required] Gets the iot_domain_group_id of this IotDomain. The `OCID`__ of the IoT domain group. __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The iot_domain_group_id of this IotDomain. :rtype: str """ return self._iot_domain_group_id @iot_domain_group_id.setter def iot_domain_group_id(self, iot_domain_group_id): """ Sets the iot_domain_group_id of this IotDomain. The `OCID`__ of the IoT domain group. __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param iot_domain_group_id: The iot_domain_group_id of this IotDomain. :type: str """ self._iot_domain_group_id = iot_domain_group_id @property def compartment_id(self): """ [Required] Gets the compartment_id of this IotDomain. The `OCID`__ of the compartment corresponding to the resource. __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :return: The compartment_id of this IotDomain. :rtype: str """ return self._compartment_id @compartment_id.setter def compartment_id(self, compartment_id): """ Sets the compartment_id of this IotDomain. The `OCID`__ of the compartment corresponding to the resource. __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param compartment_id: The compartment_id of this IotDomain. :type: str """ self._compartment_id = compartment_id @property def display_name(self): """ [Required] Gets the display_name of this IotDomain. A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. :return: The display_name of this IotDomain. :rtype: str """ return self._display_name @display_name.setter def display_name(self, display_name): """ Sets the display_name of this IotDomain. 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 IotDomain. :type: str """ self._display_name = display_name @property def description(self): """ Gets the description of this IotDomain. A short description of the resource. :return: The description of this IotDomain. :rtype: str """ return self._description @description.setter def description(self, description): """ Sets the description of this IotDomain. A short description of the resource. :param description: The description of this IotDomain. :type: str """ self._description = description @property def device_host(self): """ Gets the device_host of this IotDomain. Host name of an IoT domain, where IoT devices can connect to. :return: The device_host of this IotDomain. :rtype: str """ return self._device_host @device_host.setter def device_host(self, device_host): """ Sets the device_host of this IotDomain. Host name of an IoT domain, where IoT devices can connect to. :param device_host: The device_host of this IotDomain. :type: str """ self._device_host = device_host @property def db_allow_listed_identity_group_names(self): """ Gets the db_allow_listed_identity_group_names of this IotDomain. List of IAM groups of form described in `here`__ that are allowed to directly connect to the data host. __ https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/mnqmn/#GUID-3634D6C9-A7F1-4875-9925-BAEA2D3C5197 :return: The db_allow_listed_identity_group_names of this IotDomain. :rtype: list[str] """ return self._db_allow_listed_identity_group_names @db_allow_listed_identity_group_names.setter def db_allow_listed_identity_group_names(self, db_allow_listed_identity_group_names): """ Sets the db_allow_listed_identity_group_names of this IotDomain. List of IAM groups of form described in `here`__ that are allowed to directly connect to the data host. __ https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/mnqmn/#GUID-3634D6C9-A7F1-4875-9925-BAEA2D3C5197 :param db_allow_listed_identity_group_names: The db_allow_listed_identity_group_names of this IotDomain. :type: list[str] """ self._db_allow_listed_identity_group_names = db_allow_listed_identity_group_names @property def db_allowed_identity_domain_host(self): """ Gets the db_allowed_identity_domain_host of this IotDomain. Host name of identity domain that is used for authenticating connect to data host via ORDS. :return: The db_allowed_identity_domain_host of this IotDomain. :rtype: str """ return self._db_allowed_identity_domain_host @db_allowed_identity_domain_host.setter def db_allowed_identity_domain_host(self, db_allowed_identity_domain_host): """ Sets the db_allowed_identity_domain_host of this IotDomain. Host name of identity domain that is used for authenticating connect to data host via ORDS. :param db_allowed_identity_domain_host: The db_allowed_identity_domain_host of this IotDomain. :type: str """ self._db_allowed_identity_domain_host = db_allowed_identity_domain_host @property def data_retention_periods_in_days(self): """ Gets the data_retention_periods_in_days of this IotDomain. :return: The data_retention_periods_in_days of this IotDomain. :rtype: oci.iot.models.DataRetentionPeriodsInDays """ return self._data_retention_periods_in_days @data_retention_periods_in_days.setter def data_retention_periods_in_days(self, data_retention_periods_in_days): """ Sets the data_retention_periods_in_days of this IotDomain. :param data_retention_periods_in_days: The data_retention_periods_in_days of this IotDomain. :type: oci.iot.models.DataRetentionPeriodsInDays """ self._data_retention_periods_in_days = data_retention_periods_in_days @property def lifecycle_state(self): """ [Required] Gets the lifecycle_state of this IotDomain. The current state of the IoT domain. Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :return: The lifecycle_state of this IotDomain. :rtype: str """ return self._lifecycle_state @lifecycle_state.setter def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this IotDomain. The current state of the IoT domain. :param lifecycle_state: The lifecycle_state of this IotDomain. :type: str """ allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED"] 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 IotDomain. 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 IotDomain. :rtype: dict(str, str) """ return self._freeform_tags @freeform_tags.setter def freeform_tags(self, freeform_tags): """ Sets the freeform_tags of this IotDomain. 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 IotDomain. :type: dict(str, str) """ self._freeform_tags = freeform_tags @property def defined_tags(self): """ Gets the defined_tags of this IotDomain. 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 IotDomain. :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 IotDomain. 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 IotDomain. :type: dict(str, dict(str, object)) """ self._defined_tags = defined_tags @property def system_tags(self): """ Gets the system_tags of this IotDomain. 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 IotDomain. :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 IotDomain. 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 IotDomain. :type: dict(str, dict(str, object)) """ self._system_tags = system_tags @property def time_created(self): """ [Required]** Gets the time_created of this IotDomain. 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 IotDomain. :rtype: datetime """ return self._time_created @time_created.setter def time_created(self, time_created): """ Sets the time_created of this IotDomain. 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 IotDomain. :type: datetime """ self._time_created = time_created @property def time_updated(self): """ Gets the time_updated of this IotDomain. 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 IotDomain. :rtype: datetime """ return self._time_updated @time_updated.setter def time_updated(self, time_updated): """ Sets the time_updated of this IotDomain. 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 IotDomain. :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.07 | proxy | phpinfo | Settings