Class SubsetDataDetails


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20181201")
    public final class SubsetDataDetails
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Details required to perform data subsetting on a target database using a subsetting policy
    Note: Objects should always be created or deserialized using the SubsetDataDetails.Builder.

    This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SubsetDataDetails.Builder, which maintain a set of all explicitly set fields called SubsetDataDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getTargetId

        public String getTargetId()
        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 value
      • getMasking

        public SubsetDataDetails.Masking getMasking()
        Indicates whether masking should be triggered after successful subsetting
        Returns:
        the value
      • getIsRerun

        public Boolean getIsRerun()
        Indicates if the request is to rerun the previously failed subsetting job
        Returns:
        the value
      • getReRunFromStep

        public SubsetDataDetails.ReRunFromStep getReRunFromStep()
        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.

        Returns:
        the value
      • getTablespace

        public String getTablespace()
        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 value
      • getIsRedoLoggingEnabled

        public Boolean getIsRedoLoggingEnabled()
        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 value
      • getIsRefreshStatsEnabled

        public Boolean getIsRefreshStatsEnabled()
        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 value
      • getParallelDegree

        public String getParallelDegree()
        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 value
      • getRecompile

        public SubsettingPolicy.Recompile getRecompile()
        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 value
      • getTargetCredentials

        public Credentials getTargetCredentials()
      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation
      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel