oci 2.125.3__py3-none-any.whl → 2.126.1__py3-none-any.whl

oci/data_safe/data_safe_client_composite_operations.py

@@ -1945,6 +1945,53 @@ class DataSafeClientCompositeOperations(object):
         except Exception as e:
             raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
 
+    def delete_masking_policy_health_report_and_wait_for_state(self, masking_policy_health_report_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
+        """
+        Calls :py:func:`~oci.data_safe.DataSafeClient.delete_masking_policy_health_report` and waits for the :py:class:`~oci.data_safe.models.WorkRequest`
+        to enter the given state(s).
+
+        :param str masking_policy_health_report_id: (required)
+            The OCID of the masking health report.
+
+        :param list[str] wait_for_states:
+            An array of states to wait on. These should be valid values for :py:attr:`~oci.data_safe.models.WorkRequest.status`
+
+        :param dict operation_kwargs:
+            A dictionary of keyword arguments to pass to :py:func:`~oci.data_safe.DataSafeClient.delete_masking_policy_health_report`
+
+        :param dict waiter_kwargs:
+            A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds``
+            as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
+        """
+        operation_result = None
+        try:
+            operation_result = self.client.delete_masking_policy_health_report(masking_policy_health_report_id, **operation_kwargs)
+        except oci.exceptions.ServiceError as e:
+            if e.status == 404:
+                return WAIT_RESOURCE_NOT_FOUND
+            else:
+                raise e
+
+        if not wait_for_states:
+            return operation_result
+        lowered_wait_for_states = [w.lower() for w in wait_for_states]
+        if 'opc-work-request-id' not in operation_result.headers:
+            return operation_result
+        wait_for_resource_id = operation_result.headers['opc-work-request-id']
+
+        try:
+            waiter_result = oci.wait_until(
+                self.client,
+                self.client.get_work_request(wait_for_resource_id),
+                evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
+                **waiter_kwargs
+            )
+            result_to_return = waiter_result
+
+            return result_to_return
+        except Exception as e:
+            raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
+
     def delete_on_prem_connector_and_wait_for_state(self, on_prem_connector_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
         """
         Calls :py:func:`~oci.data_safe.DataSafeClient.delete_on_prem_connector` and waits for the :py:class:`~oci.data_safe.models.WorkRequest`
@@ -2644,6 +2691,48 @@ class DataSafeClientCompositeOperations(object):
         except Exception as e:
             raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
 
+    def generate_health_report_and_wait_for_state(self, masking_policy_id, generate_health_report_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
+        """
+        Calls :py:func:`~oci.data_safe.DataSafeClient.generate_health_report` and waits for the :py:class:`~oci.data_safe.models.WorkRequest`
+        to enter the given state(s).
+
+        :param str masking_policy_id: (required)
+            The OCID of the masking policy.
+
+        :param oci.data_safe.models.GenerateHealthReportDetails generate_health_report_details: (required)
+            Details to perform an health check.
+
+        :param list[str] wait_for_states:
+            An array of states to wait on. These should be valid values for :py:attr:`~oci.data_safe.models.WorkRequest.status`
+
+        :param dict operation_kwargs:
+            A dictionary of keyword arguments to pass to :py:func:`~oci.data_safe.DataSafeClient.generate_health_report`
+
+        :param dict waiter_kwargs:
+            A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds``
+            as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
+        """
+        operation_result = self.client.generate_health_report(masking_policy_id, generate_health_report_details, **operation_kwargs)
+        if not wait_for_states:
+            return operation_result
+        lowered_wait_for_states = [w.lower() for w in wait_for_states]
+        if 'opc-work-request-id' not in operation_result.headers:
+            return operation_result
+        wait_for_resource_id = operation_result.headers['opc-work-request-id']
+
+        try:
+            waiter_result = oci.wait_until(
+                self.client,
+                self.client.get_work_request(wait_for_resource_id),
+                evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
+                **waiter_kwargs
+            )
+            result_to_return = waiter_result
+
+            return result_to_return
+        except Exception as e:
+            raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
+
     def generate_masking_policy_for_download_and_wait_for_state(self, masking_policy_id, generate_masking_policy_for_download_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
         """
         Calls :py:func:`~oci.data_safe.DataSafeClient.generate_masking_policy_for_download` and waits for the :py:class:`~oci.data_safe.models.WorkRequest`

oci/data_safe/models/__init__.py

@@ -65,6 +65,7 @@ from .change_database_security_config_compartment_details import ChangeDatabaseS
 from .change_discovery_job_compartment_details import ChangeDiscoveryJobCompartmentDetails
 from .change_library_masking_format_compartment_details import ChangeLibraryMaskingFormatCompartmentDetails
 from .change_masking_policy_compartment_details import ChangeMaskingPolicyCompartmentDetails
+from .change_masking_policy_health_report_compartment_details import ChangeMaskingPolicyHealthReportCompartmentDetails
 from .change_on_prem_connector_compartment_details import ChangeOnPremConnectorCompartmentDetails
 from .change_report_compartment_details import ChangeReportCompartmentDetails
 from .change_report_definition_compartment_details import ChangeReportDefinitionCompartmentDetails
@@ -177,6 +178,7 @@ from .format_summary import FormatSummary
 from .formats_for_data_type import FormatsForDataType
 from .formats_for_sensitive_type import FormatsForSensitiveType
 from .generate_discovery_report_for_download_details import GenerateDiscoveryReportForDownloadDetails
+from .generate_health_report_details import GenerateHealthReportDetails
 from .generate_masking_policy_for_download_details import GenerateMaskingPolicyForDownloadDetails
 from .generate_masking_report_for_download_details import GenerateMaskingReportForDownloadDetails
 from .generate_on_prem_connector_configuration_details import GenerateOnPremConnectorConfigurationDetails
@@ -206,6 +208,11 @@ from .masking_object_collection import MaskingObjectCollection
 from .masking_object_summary import MaskingObjectSummary
 from .masking_policy import MaskingPolicy
 from .masking_policy_collection import MaskingPolicyCollection
+from .masking_policy_health_report import MaskingPolicyHealthReport
+from .masking_policy_health_report_collection import MaskingPolicyHealthReportCollection
+from .masking_policy_health_report_log_collection import MaskingPolicyHealthReportLogCollection
+from .masking_policy_health_report_log_summary import MaskingPolicyHealthReportLogSummary
+from .masking_policy_health_report_summary import MaskingPolicyHealthReportSummary
 from .masking_policy_summary import MaskingPolicySummary
 from .masking_report import MaskingReport
 from .masking_report_collection import MaskingReportCollection
@@ -460,6 +467,7 @@ data_safe_type_mapping = {
     "ChangeDiscoveryJobCompartmentDetails": ChangeDiscoveryJobCompartmentDetails,
     "ChangeLibraryMaskingFormatCompartmentDetails": ChangeLibraryMaskingFormatCompartmentDetails,
     "ChangeMaskingPolicyCompartmentDetails": ChangeMaskingPolicyCompartmentDetails,
+    "ChangeMaskingPolicyHealthReportCompartmentDetails": ChangeMaskingPolicyHealthReportCompartmentDetails,
     "ChangeOnPremConnectorCompartmentDetails": ChangeOnPremConnectorCompartmentDetails,
     "ChangeReportCompartmentDetails": ChangeReportCompartmentDetails,
     "ChangeReportDefinitionCompartmentDetails": ChangeReportDefinitionCompartmentDetails,
@@ -572,6 +580,7 @@ data_safe_type_mapping = {
     "FormatsForDataType": FormatsForDataType,
     "FormatsForSensitiveType": FormatsForSensitiveType,
     "GenerateDiscoveryReportForDownloadDetails": GenerateDiscoveryReportForDownloadDetails,
+    "GenerateHealthReportDetails": GenerateHealthReportDetails,
     "GenerateMaskingPolicyForDownloadDetails": GenerateMaskingPolicyForDownloadDetails,
     "GenerateMaskingReportForDownloadDetails": GenerateMaskingReportForDownloadDetails,
     "GenerateOnPremConnectorConfigurationDetails": GenerateOnPremConnectorConfigurationDetails,
@@ -601,6 +610,11 @@ data_safe_type_mapping = {
     "MaskingObjectSummary": MaskingObjectSummary,
     "MaskingPolicy": MaskingPolicy,
     "MaskingPolicyCollection": MaskingPolicyCollection,
+    "MaskingPolicyHealthReport": MaskingPolicyHealthReport,
+    "MaskingPolicyHealthReportCollection": MaskingPolicyHealthReportCollection,
+    "MaskingPolicyHealthReportLogCollection": MaskingPolicyHealthReportLogCollection,
+    "MaskingPolicyHealthReportLogSummary": MaskingPolicyHealthReportLogSummary,
+    "MaskingPolicyHealthReportSummary": MaskingPolicyHealthReportSummary,
     "MaskingPolicySummary": MaskingPolicySummary,
     "MaskingReport": MaskingReport,
     "MaskingReportCollection": MaskingReportCollection,

oci/data_safe/models/change_masking_policy_health_report_compartment_details.py

@@ -0,0 +1,72 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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: 20181201
+
+
+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 ChangeMaskingPolicyHealthReportCompartmentDetails(object):
+    """
+    Details to change the compartment of a masking policy.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ChangeMaskingPolicyHealthReportCompartmentDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this ChangeMaskingPolicyHealthReportCompartmentDetails.
+        :type compartment_id: str
+
+        """
+        self.swagger_types = {
+            'compartment_id': 'str'
+        }
+
+        self.attribute_map = {
+            'compartment_id': 'compartmentId'
+        }
+
+        self._compartment_id = None
+
+    @property
+    def compartment_id(self):
+        """
+        **[Required]** Gets the compartment_id of this ChangeMaskingPolicyHealthReportCompartmentDetails.
+        The OCID of the compartment where the masking policy should be moved.
+
+
+        :return: The compartment_id of this ChangeMaskingPolicyHealthReportCompartmentDetails.
+        :rtype: str
+        """
+        return self._compartment_id
+
+    @compartment_id.setter
+    def compartment_id(self, compartment_id):
+        """
+        Sets the compartment_id of this ChangeMaskingPolicyHealthReportCompartmentDetails.
+        The OCID of the compartment where the masking policy should be moved.
+
+
+        :param compartment_id: The compartment_id of this ChangeMaskingPolicyHealthReportCompartmentDetails.
+        :type: str
+        """
+        self._compartment_id = compartment_id
+
+    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

oci/data_safe/models/generate_health_report_details.py

@@ -0,0 +1,261 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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: 20181201
+
+
+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 GenerateHealthReportDetails(object):
+    """
+    Details to use when performing health check on a masking policy.
+    """
+
+    #: A constant which can be used with the check_type property of a GenerateHealthReportDetails.
+    #: This constant has a value of "ALL"
+    CHECK_TYPE_ALL = "ALL"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new GenerateHealthReportDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param check_type:
+            The value to assign to the check_type property of this GenerateHealthReportDetails.
+            Allowed values for this property are: "ALL"
+        :type check_type: str
+
+        :param target_id:
+            The value to assign to the target_id property of this GenerateHealthReportDetails.
+        :type target_id: str
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this GenerateHealthReportDetails.
+        :type compartment_id: str
+
+        :param tablespace:
+            The value to assign to the tablespace property of this GenerateHealthReportDetails.
+        :type tablespace: str
+
+        :param freeform_tags:
+            The value to assign to the freeform_tags property of this GenerateHealthReportDetails.
+        :type freeform_tags: dict(str, str)
+
+        :param defined_tags:
+            The value to assign to the defined_tags property of this GenerateHealthReportDetails.
+        :type defined_tags: dict(str, dict(str, object))
+
+        """
+        self.swagger_types = {
+            'check_type': 'str',
+            'target_id': 'str',
+            'compartment_id': 'str',
+            'tablespace': 'str',
+            'freeform_tags': 'dict(str, str)',
+            'defined_tags': 'dict(str, dict(str, object))'
+        }
+
+        self.attribute_map = {
+            'check_type': 'checkType',
+            'target_id': 'targetId',
+            'compartment_id': 'compartmentId',
+            'tablespace': 'tablespace',
+            'freeform_tags': 'freeformTags',
+            'defined_tags': 'definedTags'
+        }
+
+        self._check_type = None
+        self._target_id = None
+        self._compartment_id = None
+        self._tablespace = None
+        self._freeform_tags = None
+        self._defined_tags = None
+
+    @property
+    def check_type(self):
+        """
+        Gets the check_type of this GenerateHealthReportDetails.
+        The type of health check. The default behaviour is to perform all health checks.
+
+        Allowed values for this property are: "ALL"
+
+
+        :return: The check_type of this GenerateHealthReportDetails.
+        :rtype: str
+        """
+        return self._check_type
+
+    @check_type.setter
+    def check_type(self, check_type):
+        """
+        Sets the check_type of this GenerateHealthReportDetails.
+        The type of health check. The default behaviour is to perform all health checks.
+
+
+        :param check_type: The check_type of this GenerateHealthReportDetails.
+        :type: str
+        """
+        allowed_values = ["ALL"]
+        if not value_allowed_none_or_none_sentinel(check_type, allowed_values):
+            raise ValueError(
+                f"Invalid value for `check_type`, must be None or one of {allowed_values}"
+            )
+        self._check_type = check_type
+
+    @property
+    def target_id(self):
+        """
+        Gets the target_id of this GenerateHealthReportDetails.
+        The OCID of the target database to use for the masking policy
+        health check. The targetId associated with the masking policy
+        is used if this is not passed.
+
+
+        :return: The target_id of this GenerateHealthReportDetails.
+        :rtype: str
+        """
+        return self._target_id
+
+    @target_id.setter
+    def target_id(self, target_id):
+        """
+        Sets the target_id of this GenerateHealthReportDetails.
+        The OCID of the target database to use for the masking policy
+        health check. The targetId associated with the masking policy
+        is used if this is not passed.
+
+
+        :param target_id: The target_id of this GenerateHealthReportDetails.
+        :type: str
+        """
+        self._target_id = target_id
+
+    @property
+    def compartment_id(self):
+        """
+        Gets the compartment_id of this GenerateHealthReportDetails.
+        The OCID of the compartment where the health report resource should be created.
+
+
+        :return: The compartment_id of this GenerateHealthReportDetails.
+        :rtype: str
+        """
+        return self._compartment_id
+
+    @compartment_id.setter
+    def compartment_id(self, compartment_id):
+        """
+        Sets the compartment_id of this GenerateHealthReportDetails.
+        The OCID of the compartment where the health report resource should be created.
+
+
+        :param compartment_id: The compartment_id of this GenerateHealthReportDetails.
+        :type: str
+        """
+        self._compartment_id = compartment_id
+
+    @property
+    def tablespace(self):
+        """
+        Gets the tablespace of this GenerateHealthReportDetails.
+        The tablespace that should be used to estimate space.
+        If no tablespace is provided, the DEFAULT tablespace is used.
+
+
+        :return: The tablespace of this GenerateHealthReportDetails.
+        :rtype: str
+        """
+        return self._tablespace
+
+    @tablespace.setter
+    def tablespace(self, tablespace):
+        """
+        Sets the tablespace of this GenerateHealthReportDetails.
+        The tablespace that should be used to estimate space.
+        If no tablespace is provided, the DEFAULT tablespace is used.
+
+
+        :param tablespace: The tablespace of this GenerateHealthReportDetails.
+        :type: str
+        """
+        self._tablespace = tablespace
+
+    @property
+    def freeform_tags(self):
+        """
+        Gets the freeform_tags of this GenerateHealthReportDetails.
+        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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
+
+
+        :return: The freeform_tags of this GenerateHealthReportDetails.
+        :rtype: dict(str, str)
+        """
+        return self._freeform_tags
+
+    @freeform_tags.setter
+    def freeform_tags(self, freeform_tags):
+        """
+        Sets the freeform_tags of this GenerateHealthReportDetails.
+        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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
+
+
+        :param freeform_tags: The freeform_tags of this GenerateHealthReportDetails.
+        :type: dict(str, str)
+        """
+        self._freeform_tags = freeform_tags
+
+    @property
+    def defined_tags(self):
+        """
+        Gets the defined_tags of this GenerateHealthReportDetails.
+        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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
+
+
+        :return: The defined_tags of this GenerateHealthReportDetails.
+        :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 GenerateHealthReportDetails.
+        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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
+
+
+        :param defined_tags: The defined_tags of this GenerateHealthReportDetails.
+        :type: dict(str, dict(str, object))
+        """
+        self._defined_tags = defined_tags
+
+    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