SubsetDataDetails¶

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

Bases: object

Details required to perform data subsetting on a target database using a subsetting policy

Attributes:

`MASKING_DISABLED`	A constant which can be used with the masking property of a SubsetDataDetails.
`MASKING_ENABLED`	A constant which can be used with the masking property of a SubsetDataDetails.
`RE_RUN_FROM_STEP_POST_SUBSETTING_SCRIPT`	A constant which can be used with the re_run_from_step property of a SubsetDataDetails.
`RE_RUN_FROM_STEP_PRE_SUBSETTING_SCRIPT`	A constant which can be used with the re_run_from_step property of a SubsetDataDetails.
`is_redo_logging_enabled`	Gets the is_redo_logging_enabled of this SubsetDataDetails.
`is_refresh_stats_enabled`	Gets the is_refresh_stats_enabled of this SubsetDataDetails.
`is_rerun`	Gets the is_rerun of this SubsetDataDetails.
`masking`	Gets the masking of this SubsetDataDetails.
`parallel_degree`	Gets the parallel_degree of this SubsetDataDetails.
`re_run_from_step`	Gets the re_run_from_step of this SubsetDataDetails.
`recompile`	Gets the recompile of this SubsetDataDetails.
`tablespace`	Gets the tablespace of this SubsetDataDetails.
`target_credentials`	[Required] Gets the target_credentials of this SubsetDataDetails.
`target_id`	Gets the target_id of this SubsetDataDetails.

Methods:

__init__(**kwargs)

Initializes a new SubsetDataDetails object with values from keyword arguments.

MASKING_DISABLED = 'DISABLED'¶: A constant which can be used with the masking property of a SubsetDataDetails. This constant has a value of “DISABLED”

MASKING_ENABLED = 'ENABLED'¶: A constant which can be used with the masking property of a SubsetDataDetails. This constant has a value of “ENABLED”

RE_RUN_FROM_STEP_POST_SUBSETTING_SCRIPT = 'POST_SUBSETTING_SCRIPT'¶: A constant which can be used with the re_run_from_step property of a SubsetDataDetails. This constant has a value of “POST_SUBSETTING_SCRIPT”

RE_RUN_FROM_STEP_PRE_SUBSETTING_SCRIPT = 'PRE_SUBSETTING_SCRIPT'¶: A constant which can be used with the re_run_from_step property of a SubsetDataDetails. This constant has a value of “PRE_SUBSETTING_SCRIPT”

__init__(**kwargs)¶

Initializes a new SubsetDataDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

target_id (str) – The value to assign to the target_id property of this SubsetDataDetails.
masking (str) – The value to assign to the masking property of this SubsetDataDetails. Allowed values for this property are: “ENABLED”, “DISABLED”
is_rerun (bool) – The value to assign to the is_rerun property of this SubsetDataDetails.
re_run_from_step (str) – The value to assign to the re_run_from_step property of this SubsetDataDetails. Allowed values for this property are: “PRE_SUBSETTING_SCRIPT”, “POST_SUBSETTING_SCRIPT”
tablespace (str) – The value to assign to the tablespace property of this SubsetDataDetails.
is_redo_logging_enabled (bool) – The value to assign to the is_redo_logging_enabled property of this SubsetDataDetails.
is_refresh_stats_enabled (bool) – The value to assign to the is_refresh_stats_enabled property of this SubsetDataDetails.
parallel_degree (str) – The value to assign to the parallel_degree property of this SubsetDataDetails.
recompile (str) – The value to assign to the recompile property of this SubsetDataDetails.
target_credentials (oci.data_safe.models.Credentials) – The value to assign to the target_credentials property of this SubsetDataDetails.

property is_redo_logging_enabled¶

Gets the is_redo_logging_enabled of this SubsetDataDetails. Indicates if redo logging is enabled during a subsetting operation. Set this attribute to true to enable redo logging. If set as false, subsetting disables redo logging and flashback logging to purge any original data from logs. However, in certain circumstances when you only want to test subsetting, rollback changes, and retry, you could enable logging and use a flashback database to retrieve the original data after it has been subsetted. If it’s not provided, the value of the isRedoLoggingEnabled attribute in the SubsettingPolicy resource is used.

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

property is_refresh_stats_enabled¶

Gets the is_refresh_stats_enabled of this SubsetDataDetails. Indicates if statistics gathering is enabled. Set this attribute to false to disable statistics gathering. The subsetting process gathers statistics on subset database tables after subsetting completes. If it’s not provided, the value of the isRefreshStatsEnabled attribute in the SubsettingPolicy resource is used.

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

property is_rerun¶

Gets the is_rerun of this SubsetDataDetails. Indicates if the request is to rerun the previously failed subsetting job

Returns: The is_rerun of this SubsetDataDetails.
Return type: bool

property masking¶

Gets the masking of this SubsetDataDetails. Indicates whether masking should be triggered after successful subsetting

Allowed values for this property are: “ENABLED”, “DISABLED”

Returns: The masking of this SubsetDataDetails.
Return type: str

property parallel_degree¶

Gets the parallel_degree of this SubsetDataDetails. Specifies options to enable parallel execution when running data subsetting. Allowed values are ‘NONE’ (no parallelism), ‘DEFAULT’ (the Oracle Database computes the optimum degree of parallelism) or an integer value to be used as the degree of parallelism. Parallel execution helps effectively use multiple CPUs and improve subsetting performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism. https://www.oracle.com/pls/topic/lookup?ctx=dblatest&en/database/oracle/oracle-database&id=VLDBG-GUID-3E2AE088-2505-465E-A8B2-AC38813EA355 If it’s not provided, the value of the parallelDegree attribute in the SubsettingPolicy resource is used.

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

property re_run_from_step¶

Gets the re_run_from_step of this SubsetDataDetails. Specifies the step from which subsetting needs to be rerun. This param will be used only when isRerun attribute is true. If PRE_SUBSETTING_SCRIPT is passed, it will rerun the pre-subsetting script, followed by subsetting, and then the post-subsetting script. If POST_SUBSETTING_SCRIPT is passed, it will rerun only the post-subsetting script. If this field is not set and isRerun is set to true, then it will default to the last failed step.

Allowed values for this property are: “PRE_SUBSETTING_SCRIPT”, “POST_SUBSETTING_SCRIPT”

Returns: The re_run_from_step of this SubsetDataDetails.
Return type: str

property recompile¶

Gets the recompile of this SubsetDataDetails. Specifies how to recompile invalid objects post data subsetting. Allowed values are ‘SERIAL’ (recompile in serial), ‘PARALLEL’ (recompile in parallel), ‘NONE’ (do not recompile). If it’s set to PARALLEL, the value of parallelDegree attribute is used. Use the built-in UTL_RECOMP package to recompile any remaining invalid objects after subsetting completes. If it’s not provided, the value of the recompile attribute in the SubsettingPolicy resource is used.

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

property tablespace¶

Gets the tablespace of this SubsetDataDetails. The tablespace that should be used to create the temporary tables for data subsetting. If no tablespace is provided, the DEFAULT tablespace is used.

Returns: The tablespace of this SubsetDataDetails.
Return type: str

property target_credentials¶

[Required] Gets the target_credentials of this SubsetDataDetails.

Returns: The target_credentials of this SubsetDataDetails.
Return type: oci.data_safe.models.Credentials

property target_id¶

Gets the target_id of this SubsetDataDetails. The OCID of the target database to be subsetted. If it’s not provided, the value of the targetId attribute in the SubsettingPolicy resource is used

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