File: //lib/mysqlsh/lib/python3.8/site-packages/oci/data_safe/models/masking_report_summary.py
# coding: utf-8
# Copyright (c) 2016, 2025, 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 MaskingReportSummary(object):
"""
Summary of a masking report.
"""
#: A constant which can be used with the lifecycle_state property of a MaskingReportSummary.
#: This constant has a value of "CREATING"
LIFECYCLE_STATE_CREATING = "CREATING"
#: A constant which can be used with the lifecycle_state property of a MaskingReportSummary.
#: This constant has a value of "ACTIVE"
LIFECYCLE_STATE_ACTIVE = "ACTIVE"
#: A constant which can be used with the lifecycle_state property of a MaskingReportSummary.
#: This constant has a value of "UPDATING"
LIFECYCLE_STATE_UPDATING = "UPDATING"
#: A constant which can be used with the lifecycle_state property of a MaskingReportSummary.
#: This constant has a value of "DELETING"
LIFECYCLE_STATE_DELETING = "DELETING"
#: A constant which can be used with the lifecycle_state property of a MaskingReportSummary.
#: This constant has a value of "DELETED"
LIFECYCLE_STATE_DELETED = "DELETED"
#: A constant which can be used with the lifecycle_state property of a MaskingReportSummary.
#: This constant has a value of "NEEDS_ATTENTION"
LIFECYCLE_STATE_NEEDS_ATTENTION = "NEEDS_ATTENTION"
#: A constant which can be used with the lifecycle_state property of a MaskingReportSummary.
#: This constant has a value of "FAILED"
LIFECYCLE_STATE_FAILED = "FAILED"
#: A constant which can be used with the masking_status property of a MaskingReportSummary.
#: This constant has a value of "FAILED"
MASKING_STATUS_FAILED = "FAILED"
#: A constant which can be used with the masking_status property of a MaskingReportSummary.
#: This constant has a value of "SUCCESS"
MASKING_STATUS_SUCCESS = "SUCCESS"
def __init__(self, **kwargs):
"""
Initializes a new MaskingReportSummary 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 MaskingReportSummary.
:type id: str
:param compartment_id:
The value to assign to the compartment_id property of this MaskingReportSummary.
:type compartment_id: str
:param masking_work_request_id:
The value to assign to the masking_work_request_id property of this MaskingReportSummary.
:type masking_work_request_id: str
:param masking_policy_id:
The value to assign to the masking_policy_id property of this MaskingReportSummary.
:type masking_policy_id: str
:param target_id:
The value to assign to the target_id property of this MaskingReportSummary.
:type target_id: str
:param total_masked_sensitive_types:
The value to assign to the total_masked_sensitive_types property of this MaskingReportSummary.
:type total_masked_sensitive_types: int
:param total_masked_schemas:
The value to assign to the total_masked_schemas property of this MaskingReportSummary.
:type total_masked_schemas: int
:param total_masked_objects:
The value to assign to the total_masked_objects property of this MaskingReportSummary.
:type total_masked_objects: int
:param total_masked_columns:
The value to assign to the total_masked_columns property of this MaskingReportSummary.
:type total_masked_columns: int
:param total_masked_values:
The value to assign to the total_masked_values property of this MaskingReportSummary.
:type total_masked_values: int
:param time_masking_started:
The value to assign to the time_masking_started property of this MaskingReportSummary.
:type time_masking_started: datetime
:param time_masking_finished:
The value to assign to the time_masking_finished property of this MaskingReportSummary.
:type time_masking_finished: datetime
:param lifecycle_state:
The value to assign to the lifecycle_state property of this MaskingReportSummary.
Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "NEEDS_ATTENTION", "FAILED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type lifecycle_state: str
:param time_created:
The value to assign to the time_created property of this MaskingReportSummary.
:type time_created: datetime
:param is_drop_temp_tables_enabled:
The value to assign to the is_drop_temp_tables_enabled property of this MaskingReportSummary.
:type is_drop_temp_tables_enabled: bool
:param is_redo_logging_enabled:
The value to assign to the is_redo_logging_enabled property of this MaskingReportSummary.
:type is_redo_logging_enabled: bool
:param is_refresh_stats_enabled:
The value to assign to the is_refresh_stats_enabled property of this MaskingReportSummary.
:type is_refresh_stats_enabled: bool
:param parallel_degree:
The value to assign to the parallel_degree property of this MaskingReportSummary.
:type parallel_degree: str
:param recompile:
The value to assign to the recompile property of this MaskingReportSummary.
:type recompile: str
:param masking_status:
The value to assign to the masking_status property of this MaskingReportSummary.
Allowed values for this property are: "FAILED", "SUCCESS", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type masking_status: str
:param total_pre_masking_script_errors:
The value to assign to the total_pre_masking_script_errors property of this MaskingReportSummary.
:type total_pre_masking_script_errors: int
:param total_post_masking_script_errors:
The value to assign to the total_post_masking_script_errors property of this MaskingReportSummary.
:type total_post_masking_script_errors: int
"""
self.swagger_types = {
'id': 'str',
'compartment_id': 'str',
'masking_work_request_id': 'str',
'masking_policy_id': 'str',
'target_id': 'str',
'total_masked_sensitive_types': 'int',
'total_masked_schemas': 'int',
'total_masked_objects': 'int',
'total_masked_columns': 'int',
'total_masked_values': 'int',
'time_masking_started': 'datetime',
'time_masking_finished': 'datetime',
'lifecycle_state': 'str',
'time_created': 'datetime',
'is_drop_temp_tables_enabled': 'bool',
'is_redo_logging_enabled': 'bool',
'is_refresh_stats_enabled': 'bool',
'parallel_degree': 'str',
'recompile': 'str',
'masking_status': 'str',
'total_pre_masking_script_errors': 'int',
'total_post_masking_script_errors': 'int'
}
self.attribute_map = {
'id': 'id',
'compartment_id': 'compartmentId',
'masking_work_request_id': 'maskingWorkRequestId',
'masking_policy_id': 'maskingPolicyId',
'target_id': 'targetId',
'total_masked_sensitive_types': 'totalMaskedSensitiveTypes',
'total_masked_schemas': 'totalMaskedSchemas',
'total_masked_objects': 'totalMaskedObjects',
'total_masked_columns': 'totalMaskedColumns',
'total_masked_values': 'totalMaskedValues',
'time_masking_started': 'timeMaskingStarted',
'time_masking_finished': 'timeMaskingFinished',
'lifecycle_state': 'lifecycleState',
'time_created': 'timeCreated',
'is_drop_temp_tables_enabled': 'isDropTempTablesEnabled',
'is_redo_logging_enabled': 'isRedoLoggingEnabled',
'is_refresh_stats_enabled': 'isRefreshStatsEnabled',
'parallel_degree': 'parallelDegree',
'recompile': 'recompile',
'masking_status': 'maskingStatus',
'total_pre_masking_script_errors': 'totalPreMaskingScriptErrors',
'total_post_masking_script_errors': 'totalPostMaskingScriptErrors'
}
self._id = None
self._compartment_id = None
self._masking_work_request_id = None
self._masking_policy_id = None
self._target_id = None
self._total_masked_sensitive_types = None
self._total_masked_schemas = None
self._total_masked_objects = None
self._total_masked_columns = None
self._total_masked_values = None
self._time_masking_started = None
self._time_masking_finished = None
self._lifecycle_state = None
self._time_created = None
self._is_drop_temp_tables_enabled = None
self._is_redo_logging_enabled = None
self._is_refresh_stats_enabled = None
self._parallel_degree = None
self._recompile = None
self._masking_status = None
self._total_pre_masking_script_errors = None
self._total_post_masking_script_errors = None
@property
def id(self):
"""
**[Required]** Gets the id of this MaskingReportSummary.
The OCID of the masking report.
:return: The id of this MaskingReportSummary.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this MaskingReportSummary.
The OCID of the masking report.
:param id: The id of this MaskingReportSummary.
:type: str
"""
self._id = id
@property
def compartment_id(self):
"""
**[Required]** Gets the compartment_id of this MaskingReportSummary.
The OCID of the compartment that contains the masking report.
:return: The compartment_id of this MaskingReportSummary.
:rtype: str
"""
return self._compartment_id
@compartment_id.setter
def compartment_id(self, compartment_id):
"""
Sets the compartment_id of this MaskingReportSummary.
The OCID of the compartment that contains the masking report.
:param compartment_id: The compartment_id of this MaskingReportSummary.
:type: str
"""
self._compartment_id = compartment_id
@property
def masking_work_request_id(self):
"""
**[Required]** Gets the masking_work_request_id of this MaskingReportSummary.
The OCID of the masking work request that resulted in this masking report.
:return: The masking_work_request_id of this MaskingReportSummary.
:rtype: str
"""
return self._masking_work_request_id
@masking_work_request_id.setter
def masking_work_request_id(self, masking_work_request_id):
"""
Sets the masking_work_request_id of this MaskingReportSummary.
The OCID of the masking work request that resulted in this masking report.
:param masking_work_request_id: The masking_work_request_id of this MaskingReportSummary.
:type: str
"""
self._masking_work_request_id = masking_work_request_id
@property
def masking_policy_id(self):
"""
**[Required]** Gets the masking_policy_id of this MaskingReportSummary.
The OCID of the masking policy used.
:return: The masking_policy_id of this MaskingReportSummary.
:rtype: str
"""
return self._masking_policy_id
@masking_policy_id.setter
def masking_policy_id(self, masking_policy_id):
"""
Sets the masking_policy_id of this MaskingReportSummary.
The OCID of the masking policy used.
:param masking_policy_id: The masking_policy_id of this MaskingReportSummary.
:type: str
"""
self._masking_policy_id = masking_policy_id
@property
def target_id(self):
"""
**[Required]** Gets the target_id of this MaskingReportSummary.
The OCID of the target database masked.
:return: The target_id of this MaskingReportSummary.
:rtype: str
"""
return self._target_id
@target_id.setter
def target_id(self, target_id):
"""
Sets the target_id of this MaskingReportSummary.
The OCID of the target database masked.
:param target_id: The target_id of this MaskingReportSummary.
:type: str
"""
self._target_id = target_id
@property
def total_masked_sensitive_types(self):
"""
**[Required]** Gets the total_masked_sensitive_types of this MaskingReportSummary.
The total number of unique sensitive types associated with the masked columns.
:return: The total_masked_sensitive_types of this MaskingReportSummary.
:rtype: int
"""
return self._total_masked_sensitive_types
@total_masked_sensitive_types.setter
def total_masked_sensitive_types(self, total_masked_sensitive_types):
"""
Sets the total_masked_sensitive_types of this MaskingReportSummary.
The total number of unique sensitive types associated with the masked columns.
:param total_masked_sensitive_types: The total_masked_sensitive_types of this MaskingReportSummary.
:type: int
"""
self._total_masked_sensitive_types = total_masked_sensitive_types
@property
def total_masked_schemas(self):
"""
**[Required]** Gets the total_masked_schemas of this MaskingReportSummary.
The total number of unique schemas that contain the masked columns.
:return: The total_masked_schemas of this MaskingReportSummary.
:rtype: int
"""
return self._total_masked_schemas
@total_masked_schemas.setter
def total_masked_schemas(self, total_masked_schemas):
"""
Sets the total_masked_schemas of this MaskingReportSummary.
The total number of unique schemas that contain the masked columns.
:param total_masked_schemas: The total_masked_schemas of this MaskingReportSummary.
:type: int
"""
self._total_masked_schemas = total_masked_schemas
@property
def total_masked_objects(self):
"""
**[Required]** Gets the total_masked_objects of this MaskingReportSummary.
The total number of unique objects (tables and editioning views) that contain the masked columns.
:return: The total_masked_objects of this MaskingReportSummary.
:rtype: int
"""
return self._total_masked_objects
@total_masked_objects.setter
def total_masked_objects(self, total_masked_objects):
"""
Sets the total_masked_objects of this MaskingReportSummary.
The total number of unique objects (tables and editioning views) that contain the masked columns.
:param total_masked_objects: The total_masked_objects of this MaskingReportSummary.
:type: int
"""
self._total_masked_objects = total_masked_objects
@property
def total_masked_columns(self):
"""
**[Required]** Gets the total_masked_columns of this MaskingReportSummary.
The total number of masked columns.
:return: The total_masked_columns of this MaskingReportSummary.
:rtype: int
"""
return self._total_masked_columns
@total_masked_columns.setter
def total_masked_columns(self, total_masked_columns):
"""
Sets the total_masked_columns of this MaskingReportSummary.
The total number of masked columns.
:param total_masked_columns: The total_masked_columns of this MaskingReportSummary.
:type: int
"""
self._total_masked_columns = total_masked_columns
@property
def total_masked_values(self):
"""
**[Required]** Gets the total_masked_values of this MaskingReportSummary.
The total number of masked values.
:return: The total_masked_values of this MaskingReportSummary.
:rtype: int
"""
return self._total_masked_values
@total_masked_values.setter
def total_masked_values(self, total_masked_values):
"""
Sets the total_masked_values of this MaskingReportSummary.
The total number of masked values.
:param total_masked_values: The total_masked_values of this MaskingReportSummary.
:type: int
"""
self._total_masked_values = total_masked_values
@property
def time_masking_started(self):
"""
**[Required]** Gets the time_masking_started of this MaskingReportSummary.
The date and time data masking started, in the format defined by `RFC3339`__
__ https://tools.ietf.org/html/rfc3339
:return: The time_masking_started of this MaskingReportSummary.
:rtype: datetime
"""
return self._time_masking_started
@time_masking_started.setter
def time_masking_started(self, time_masking_started):
"""
Sets the time_masking_started of this MaskingReportSummary.
The date and time data masking started, in the format defined by `RFC3339`__
__ https://tools.ietf.org/html/rfc3339
:param time_masking_started: The time_masking_started of this MaskingReportSummary.
:type: datetime
"""
self._time_masking_started = time_masking_started
@property
def time_masking_finished(self):
"""
**[Required]** Gets the time_masking_finished of this MaskingReportSummary.
The date and time data masking finished, in the format defined by `RFC3339`__
__ https://tools.ietf.org/html/rfc3339
:return: The time_masking_finished of this MaskingReportSummary.
:rtype: datetime
"""
return self._time_masking_finished
@time_masking_finished.setter
def time_masking_finished(self, time_masking_finished):
"""
Sets the time_masking_finished of this MaskingReportSummary.
The date and time data masking finished, in the format defined by `RFC3339`__
__ https://tools.ietf.org/html/rfc3339
:param time_masking_finished: The time_masking_finished of this MaskingReportSummary.
:type: datetime
"""
self._time_masking_finished = time_masking_finished
@property
def lifecycle_state(self):
"""
**[Required]** Gets the lifecycle_state of this MaskingReportSummary.
The current state of the masking report.
Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "NEEDS_ATTENTION", "FAILED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The lifecycle_state of this MaskingReportSummary.
:rtype: str
"""
return self._lifecycle_state
@lifecycle_state.setter
def lifecycle_state(self, lifecycle_state):
"""
Sets the lifecycle_state of this MaskingReportSummary.
The current state of the masking report.
:param lifecycle_state: The lifecycle_state of this MaskingReportSummary.
:type: str
"""
allowed_values = ["CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "NEEDS_ATTENTION", "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 time_created(self):
"""
Gets the time_created of this MaskingReportSummary.
The date and time the masking report was created, in the format defined by `RFC3339`__.
__ https://tools.ietf.org/html/rfc3339
:return: The time_created of this MaskingReportSummary.
:rtype: datetime
"""
return self._time_created
@time_created.setter
def time_created(self, time_created):
"""
Sets the time_created of this MaskingReportSummary.
The date and time the masking report was created, in the format defined by `RFC3339`__.
__ https://tools.ietf.org/html/rfc3339
:param time_created: The time_created of this MaskingReportSummary.
:type: datetime
"""
self._time_created = time_created
@property
def is_drop_temp_tables_enabled(self):
"""
Gets the is_drop_temp_tables_enabled of this MaskingReportSummary.
Indicates if the temporary tables created during the masking operation were dropped after masking.
:return: The is_drop_temp_tables_enabled of this MaskingReportSummary.
:rtype: bool
"""
return self._is_drop_temp_tables_enabled
@is_drop_temp_tables_enabled.setter
def is_drop_temp_tables_enabled(self, is_drop_temp_tables_enabled):
"""
Sets the is_drop_temp_tables_enabled of this MaskingReportSummary.
Indicates if the temporary tables created during the masking operation were dropped after masking.
:param is_drop_temp_tables_enabled: The is_drop_temp_tables_enabled of this MaskingReportSummary.
:type: bool
"""
self._is_drop_temp_tables_enabled = is_drop_temp_tables_enabled
@property
def is_redo_logging_enabled(self):
"""
Gets the is_redo_logging_enabled of this MaskingReportSummary.
Indicates if redo logging was enabled during the masking operation.
:return: The is_redo_logging_enabled of this MaskingReportSummary.
:rtype: bool
"""
return self._is_redo_logging_enabled
@is_redo_logging_enabled.setter
def is_redo_logging_enabled(self, is_redo_logging_enabled):
"""
Sets the is_redo_logging_enabled of this MaskingReportSummary.
Indicates if redo logging was enabled during the masking operation.
:param is_redo_logging_enabled: The is_redo_logging_enabled of this MaskingReportSummary.
:type: bool
"""
self._is_redo_logging_enabled = is_redo_logging_enabled
@property
def is_refresh_stats_enabled(self):
"""
Gets the is_refresh_stats_enabled of this MaskingReportSummary.
Indicates if statistics gathering was enabled during the masking operation.
:return: The is_refresh_stats_enabled of this MaskingReportSummary.
:rtype: bool
"""
return self._is_refresh_stats_enabled
@is_refresh_stats_enabled.setter
def is_refresh_stats_enabled(self, is_refresh_stats_enabled):
"""
Sets the is_refresh_stats_enabled of this MaskingReportSummary.
Indicates if statistics gathering was enabled during the masking operation.
:param is_refresh_stats_enabled: The is_refresh_stats_enabled of this MaskingReportSummary.
:type: bool
"""
self._is_refresh_stats_enabled = is_refresh_stats_enabled
@property
def parallel_degree(self):
"""
Gets the parallel_degree of this MaskingReportSummary.
Indicates if parallel execution was enabled during the masking operation.
:return: The parallel_degree of this MaskingReportSummary.
:rtype: str
"""
return self._parallel_degree
@parallel_degree.setter
def parallel_degree(self, parallel_degree):
"""
Sets the parallel_degree of this MaskingReportSummary.
Indicates if parallel execution was enabled during the masking operation.
:param parallel_degree: The parallel_degree of this MaskingReportSummary.
:type: str
"""
self._parallel_degree = parallel_degree
@property
def recompile(self):
"""
Gets the recompile of this MaskingReportSummary.
Indicates how invalid objects were recompiled post the masking operation.
:return: The recompile of this MaskingReportSummary.
:rtype: str
"""
return self._recompile
@recompile.setter
def recompile(self, recompile):
"""
Sets the recompile of this MaskingReportSummary.
Indicates how invalid objects were recompiled post the masking operation.
:param recompile: The recompile of this MaskingReportSummary.
:type: str
"""
self._recompile = recompile
@property
def masking_status(self):
"""
**[Required]** Gets the masking_status of this MaskingReportSummary.
The status of the masking job.
Allowed values for this property are: "FAILED", "SUCCESS", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The masking_status of this MaskingReportSummary.
:rtype: str
"""
return self._masking_status
@masking_status.setter
def masking_status(self, masking_status):
"""
Sets the masking_status of this MaskingReportSummary.
The status of the masking job.
:param masking_status: The masking_status of this MaskingReportSummary.
:type: str
"""
allowed_values = ["FAILED", "SUCCESS"]
if not value_allowed_none_or_none_sentinel(masking_status, allowed_values):
masking_status = 'UNKNOWN_ENUM_VALUE'
self._masking_status = masking_status
@property
def total_pre_masking_script_errors(self):
"""
Gets the total_pre_masking_script_errors of this MaskingReportSummary.
The total number of errors in pre-masking script.
:return: The total_pre_masking_script_errors of this MaskingReportSummary.
:rtype: int
"""
return self._total_pre_masking_script_errors
@total_pre_masking_script_errors.setter
def total_pre_masking_script_errors(self, total_pre_masking_script_errors):
"""
Sets the total_pre_masking_script_errors of this MaskingReportSummary.
The total number of errors in pre-masking script.
:param total_pre_masking_script_errors: The total_pre_masking_script_errors of this MaskingReportSummary.
:type: int
"""
self._total_pre_masking_script_errors = total_pre_masking_script_errors
@property
def total_post_masking_script_errors(self):
"""
Gets the total_post_masking_script_errors of this MaskingReportSummary.
The total number of errors in post-masking script.
:return: The total_post_masking_script_errors of this MaskingReportSummary.
:rtype: int
"""
return self._total_post_masking_script_errors
@total_post_masking_script_errors.setter
def total_post_masking_script_errors(self, total_post_masking_script_errors):
"""
Sets the total_post_masking_script_errors of this MaskingReportSummary.
The total number of errors in post-masking script.
:param total_post_masking_script_errors: The total_post_masking_script_errors of this MaskingReportSummary.
:type: int
"""
self._total_post_masking_script_errors = total_post_masking_script_errors
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