com.oracle.bmc.datasafe.model

Class MaskDataDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.datasafe.model.MaskDataDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public final class MaskDataDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Details to mask data.
Note: Objects should always be created or deserialized using the MaskDataDetails.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 MaskDataDetails.Builder, which maintain a set of all explicitly set fields called MaskDataDetails.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MaskDataDetails.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
MaskDataDetails(String targetId, Boolean isDecrypt, Boolean isRerun, String tablespace, Boolean isIgnoreErrorsEnabled, String seed, Boolean isMoveInterimTablesEnabled, Boolean isExecuteSavedScriptEnabled, Boolean isDropTempTablesEnabled, Boolean isRedoLoggingEnabled, Boolean isRefreshStatsEnabled, String parallelDegree, String recompile) Deprecated.

Method Summary

Modifier and Type	Method and Description
static MaskDataDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
Boolean	getIsDecrypt() Indicates if the masking request is to decrypt the data values previously encrypted using Deterministic Encryption.
Boolean	getIsDropTempTablesEnabled() Indicates if the temporary tables created during a masking operation should be dropped after masking.
Boolean	getIsExecuteSavedScriptEnabled() Indicates if data masking should be performed using a saved masking script.
Boolean	getIsIgnoreErrorsEnabled() Indicates if the masking process should continue on hitting an error.
Boolean	getIsMoveInterimTablesEnabled() Indicates if the interim DMASK tables should be moved to the user-specified tablespace.
Boolean	getIsRedoLoggingEnabled() Indicates if redo logging is enabled during a masking operation.
Boolean	getIsRefreshStatsEnabled() Indicates if statistics gathering is enabled.
Boolean	getIsRerun() Indicates if the masking request is to rerun the previously failed masking steps.
String	getParallelDegree() Specifies options to enable parallel execution when running data masking.
String	getRecompile() Specifies how to recompile invalid objects post data masking.
String	getSeed() The seed value to be used in case of Deterministic Encryption and Deterministic Substitution masking formats.
String	getTablespace() The tablespace that should be used to create the mapping tables, DMASK objects, and other temporary tables for data masking.
String	getTargetId() The OCID of the target database to be masked.
int	hashCode()
MaskDataDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MaskDataDetails

@Deprecated
 @ConstructorProperties(value={"targetId","isDecrypt","isRerun","tablespace","isIgnoreErrorsEnabled","seed","isMoveInterimTablesEnabled","isExecuteSavedScriptEnabled","isDropTempTablesEnabled","isRedoLoggingEnabled","isRefreshStatsEnabled","parallelDegree","recompile"})
public MaskDataDetails(String targetId,
                                                                                                                                                                                                                                                                                                                  Boolean isDecrypt,
                                                                                                                                                                                                                                                                                                                  Boolean isRerun,
                                                                                                                                                                                                                                                                                                                  String tablespace,
                                                                                                                                                                                                                                                                                                                  Boolean isIgnoreErrorsEnabled,
                                                                                                                                                                                                                                                                                                                  String seed,
                                                                                                                                                                                                                                                                                                                  Boolean isMoveInterimTablesEnabled,
                                                                                                                                                                                                                                                                                                                  Boolean isExecuteSavedScriptEnabled,
                                                                                                                                                                                                                                                                                                                  Boolean isDropTempTablesEnabled,
                                                                                                                                                                                                                                                                                                                  Boolean isRedoLoggingEnabled,
                                                                                                                                                                                                                                                                                                                  Boolean isRefreshStatsEnabled,
                                                                                                                                                                                                                                                                                                                  String parallelDegree,
                                                                                                                                                                                                                                                                                                                  String recompile)

Deprecated.

Method Detail

builder

public static MaskDataDetails.Builder builder()

Create a new builder.

toBuilder

public MaskDataDetails.Builder toBuilder()

getTargetId

public String getTargetId()

The OCID of the target database to be masked. If it’s not provided, the value of the targetId attribute in the MaskingPolicy resource is used. The OCID of the target database to be masked. If it’s not provided, the value of the targetId attribute in the MaskingPolicy resource is used.

Returns:

the value

getIsDecrypt

public Boolean getIsDecrypt()

Indicates if the masking request is to decrypt the data values previously encrypted using Deterministic Encryption. Note that, to correctly decrypt the encrypted data values, it requires the same seed value that was provided to encrypt those data values.

Returns:

the value

getIsRerun

public Boolean getIsRerun()

Indicates if the masking request is to rerun the previously failed masking steps. If a masking request is submitted with the isIgnoreErrorsEnabled attribute set to true, the masking process tracks the failed masking steps. Another masking request can be submitted with the isRun attribute set to true to rerun those failed masking steps. It helps save time by executing only the failed masking steps and not doing the whole masking again.

Returns:

the value

getTablespace

public String getTablespace()

The tablespace that should be used to create the mapping tables, DMASK objects, and other temporary tables for data masking. If no tablespace is provided, the DEFAULT tablespace is used.

Returns:

the value

getIsIgnoreErrorsEnabled

public Boolean getIsIgnoreErrorsEnabled()

Indicates if the masking process should continue on hitting an error. It provides fault tolerance support and is enabled by default. In fault-tolerant mode, the masking process saves the failed step and continues. You can then submit another masking request (with isRerun attribute set to true) to execute only the failed steps.

Returns:

the value

getSeed

public String getSeed()

The seed value to be used in case of Deterministic Encryption and Deterministic Substitution masking formats.

Returns:

the value

getIsMoveInterimTablesEnabled

public Boolean getIsMoveInterimTablesEnabled()

Indicates if the interim DMASK tables should be moved to the user-specified tablespace. As interim tables can be large in size, set it to false if moving them causes performance overhead during masking.

Returns:

the value

getIsExecuteSavedScriptEnabled

public Boolean getIsExecuteSavedScriptEnabled()

Indicates if data masking should be performed using a saved masking script. Setting this attribute to true skips masking script generation and executes the masking script stored in the Data Safe repository. It helps save time if there are no changes in the database tables and their dependencies.

Returns:

the value

getIsDropTempTablesEnabled

public Boolean getIsDropTempTablesEnabled()

Indicates if the temporary tables created during a masking operation should be dropped after masking. Set this attribute to false to preserve the temporary tables. Masking creates temporary tables that map the original sensitive data values to mask values. These temporary tables are dropped after masking if this attribute is set as true. But, in some cases, you may want to preserve this information to track how masking changed your data. Note that doing so compromises security. These tables must be dropped before the database is available for unprivileged users. If it’s not provided, the value of the isDropTempTablesEnabled attribute in the MaskingPolicy resource is used.

Returns:

the value

getIsRedoLoggingEnabled

public Boolean getIsRedoLoggingEnabled()

Indicates if redo logging is enabled during a masking operation. Set this attribute to true to enable redo logging. If set as false, masking disables redo logging and flashback logging to purge any original unmasked data from logs. However, in certain circumstances when you only want to test masking, rollback changes, and retry masking, you could enable logging and use a flashback database to retrieve the original unmasked data after it has been masked. If it’s not provided, the value of the isRedoLoggingEnabled attribute in the MaskingPolicy 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 masking process gathers statistics on masked database tables after masking completes. If it’s not provided, the value of the isRefreshStatsEnabled attribute in the MaskingPolicy resource is used.

Returns:

the value

getParallelDegree

public String getParallelDegree()

Specifies options to enable parallel execution when running data masking. 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 masking 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 MaskingPolicy resource is used.

Returns:

the value

getRecompile

public String getRecompile()

Specifies how to recompile invalid objects post data masking. 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 masking completes. If it’s not provided, the value of the parallelDegree attribute in the MaskingPolicy resource is used.

Returns:

the value

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