MaskingReport¶

class oci.data_safe.models.MaskingReport(**kwargs)¶

Bases: object

A masking report contains information about a completed masking request. It includes details such as the target database masked, masking policy used, masking start and finish time, total number of schemas, tables, columns and values masked, masked columns, and the masking formats used.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a MaskingReport.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a MaskingReport.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a MaskingReport.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a MaskingReport.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a MaskingReport.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a MaskingReport.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a MaskingReport.
`compartment_id`	[Required] Gets the compartment_id of this MaskingReport.
`id`	[Required] Gets the id of this MaskingReport.
`is_drop_temp_tables_enabled`	Gets the is_drop_temp_tables_enabled of this MaskingReport.
`is_redo_logging_enabled`	Gets the is_redo_logging_enabled of this MaskingReport.
`is_refresh_stats_enabled`	Gets the is_refresh_stats_enabled of this MaskingReport.
`lifecycle_state`	[Required] Gets the lifecycle_state of this MaskingReport.
`masking_policy_id`	[Required] Gets the masking_policy_id of this MaskingReport.
`masking_work_request_id`	[Required] Gets the masking_work_request_id of this MaskingReport.
`parallel_degree`	Gets the parallel_degree of this MaskingReport.
`recompile`	Gets the recompile of this MaskingReport.
`target_id`	[Required] Gets the target_id of this MaskingReport.
`time_created`	Gets the time_created of this MaskingReport.
`time_masking_finished`	[Required] Gets the time_masking_finished of this MaskingReport.
`time_masking_started`	[Required] Gets the time_masking_started of this MaskingReport.
`total_masked_columns`	[Required] Gets the total_masked_columns of this MaskingReport.
`total_masked_objects`	[Required] Gets the total_masked_objects of this MaskingReport.
`total_masked_schemas`	[Required] Gets the total_masked_schemas of this MaskingReport.
`total_masked_sensitive_types`	[Required] Gets the total_masked_sensitive_types of this MaskingReport.
`total_masked_values`	[Required] Gets the total_masked_values of this MaskingReport.

Methods

__init__(**kwargs) Initializes a new MaskingReport object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a MaskingReport. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a MaskingReport. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a MaskingReport. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a MaskingReport. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a MaskingReport. This constant has a value of “FAILED”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a MaskingReport. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a MaskingReport. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new MaskingReport 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 MaskingReport.
compartment_id (str) – The value to assign to the compartment_id property of this MaskingReport.
masking_work_request_id (str) – The value to assign to the masking_work_request_id property of this MaskingReport.
masking_policy_id (str) – The value to assign to the masking_policy_id property of this MaskingReport.
target_id (str) – The value to assign to the target_id property of this MaskingReport.
total_masked_sensitive_types (int) – The value to assign to the total_masked_sensitive_types property of this MaskingReport.
total_masked_schemas (int) – The value to assign to the total_masked_schemas property of this MaskingReport.
total_masked_objects (int) – The value to assign to the total_masked_objects property of this MaskingReport.
total_masked_columns (int) – The value to assign to the total_masked_columns property of this MaskingReport.
total_masked_values (int) – The value to assign to the total_masked_values property of this MaskingReport.
time_masking_started (datetime) – The value to assign to the time_masking_started property of this MaskingReport.
time_masking_finished (datetime) – The value to assign to the time_masking_finished property of this MaskingReport.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this MaskingReport. 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’.
time_created (datetime) – The value to assign to the time_created property of this MaskingReport.
is_drop_temp_tables_enabled (bool) – The value to assign to the is_drop_temp_tables_enabled property of this MaskingReport.
is_redo_logging_enabled (bool) – The value to assign to the is_redo_logging_enabled property of this MaskingReport.
is_refresh_stats_enabled (bool) – The value to assign to the is_refresh_stats_enabled property of this MaskingReport.
parallel_degree (str) – The value to assign to the parallel_degree property of this MaskingReport.
recompile (str) – The value to assign to the recompile property of this MaskingReport.

compartment_id¶

[Required] Gets the compartment_id of this MaskingReport. The OCID of the compartment that contains the masking report.

Returns:	The compartment_id of this MaskingReport.
Return type:	str

id¶

[Required] Gets the id of this MaskingReport. The OCID of the masking report.

Returns:	The id of this MaskingReport.
Return type:	str

is_drop_temp_tables_enabled¶

Gets the is_drop_temp_tables_enabled of this MaskingReport. Indicates if the temporary tables created during the masking operation were dropped after masking.

Returns:	The is_drop_temp_tables_enabled of this MaskingReport.
Return type:	bool

is_redo_logging_enabled¶

Gets the is_redo_logging_enabled of this MaskingReport. Indicates if redo logging was enabled during the masking operation.

Returns:	The is_redo_logging_enabled of this MaskingReport.
Return type:	bool

is_refresh_stats_enabled¶

Gets the is_refresh_stats_enabled of this MaskingReport. Indicates if statistics gathering was enabled during the masking operation.

Returns:	The is_refresh_stats_enabled of this MaskingReport.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this MaskingReport. 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’.

Returns:	The lifecycle_state of this MaskingReport.
Return type:	str

masking_policy_id¶

[Required] Gets the masking_policy_id of this MaskingReport. The OCID of the masking policy used.

Returns:	The masking_policy_id of this MaskingReport.
Return type:	str

masking_work_request_id¶

[Required] Gets the masking_work_request_id of this MaskingReport. The OCID of the masking work request that resulted in this masking report.

Returns:	The masking_work_request_id of this MaskingReport.
Return type:	str

parallel_degree¶

Gets the parallel_degree of this MaskingReport. Indicates if parallel execution was enabled during the masking operation.

Returns:	The parallel_degree of this MaskingReport.
Return type:	str

recompile¶

Gets the recompile of this MaskingReport. Indicates how invalid objects were recompiled post the masking operation.

Returns:	The recompile of this MaskingReport.
Return type:	str

target_id¶

[Required] Gets the target_id of this MaskingReport. The OCID of the target database masked.

Returns:	The target_id of this MaskingReport.
Return type:	str

time_created¶

Gets the time_created of this MaskingReport. The date and time the masking report was created, in the format defined by RFC3339.

Returns:	The time_created of this MaskingReport.
Return type:	datetime

time_masking_finished¶

[Required] Gets the time_masking_finished of this MaskingReport. The date and time data masking finished, in the format defined by RFC3339

Returns:	The time_masking_finished of this MaskingReport.
Return type:	datetime

time_masking_started¶

[Required] Gets the time_masking_started of this MaskingReport. The date and time data masking started, in the format defined by RFC3339

Returns:	The time_masking_started of this MaskingReport.
Return type:	datetime

total_masked_columns¶

[Required] Gets the total_masked_columns of this MaskingReport. The total number of masked columns.

Returns:	The total_masked_columns of this MaskingReport.
Return type:	int

total_masked_objects¶

[Required] Gets the total_masked_objects of this MaskingReport. The total number of unique objects (tables and editioning views) that contain the masked columns.

Returns:	The total_masked_objects of this MaskingReport.
Return type:	int

total_masked_schemas¶

[Required] Gets the total_masked_schemas of this MaskingReport. The total number of unique schemas that contain the masked columns.

Returns:	The total_masked_schemas of this MaskingReport.
Return type:	int

total_masked_sensitive_types¶

[Required] Gets the total_masked_sensitive_types of this MaskingReport. The total number of unique sensitive types associated with the masked columns.

Returns:	The total_masked_sensitive_types of this MaskingReport.
Return type:	int

total_masked_values¶

[Required] Gets the total_masked_values of this MaskingReport. The total number of masked values.

Returns:	The total_masked_values of this MaskingReport.
Return type:	int