com.oracle.bmc.datasafe.model

Class CreateMaskingPolicyDetails

java.lang.Object

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

com.oracle.bmc.datasafe.model.CreateMaskingPolicyDetails

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

Details to create a new masking policy. Use either a sensitive data model or a reference target database to create your masking policy.

To use a sensitive data model as the source of masking columns, set the columnSource attribute to SENSITIVE_DATA_MODEL and provide the sensitiveDataModelId attribute. After creating a masking policy, you can use the AddMaskingColumnsFromSdm operation to automatically add all the columns from the associated sensitive data model. In this case, the target database associated with the sensitive data model is used for column and masking format validations.

You can also create a masking policy without using a sensitive data model. In this case, you need to associate your masking policy with a target database by setting the columnSource attribute to TARGET and providing the targetId attribute. The specified target database is used for column and masking format validations.

After creating a masking policy, you can use the CreateMaskingColumn or PatchMaskingColumns operation to manually add columns to the policy. You need to add the parent columns only, and it automatically adds the child columns (in referential relationship with the parent columns) from the associated sensitive data model or target database.
Note: Objects should always be created or deserialized using the CreateMaskingPolicyDetails.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 CreateMaskingPolicyDetails.Builder, which maintain a set of all explicitly set fields called CreateMaskingPolicyDetails.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	CreateMaskingPolicyDetails.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

CreateMaskingPolicyDetails(String displayName, String compartmentId, String description, Boolean isDropTempTablesEnabled, Boolean isRedoLoggingEnabled, Boolean isRefreshStatsEnabled, String parallelDegree, MaskingPolicy.Recompile recompile, String preMaskingScript, String postMaskingScript, CreateColumnSourceDetails columnSource, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags) Deprecated.

Method Summary

Modifier and Type	Method and Description
static CreateMaskingPolicyDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
CreateColumnSourceDetails	getColumnSource()
String	getCompartmentId() The OCID of the compartment where the masking policy should be created.
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getDescription() The description of the masking policy.
String	getDisplayName() The display name of the masking policy.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
Boolean	getIsDropTempTablesEnabled() Indicates if the temporary tables created during a masking operation should be dropped after masking.
Boolean	getIsRedoLoggingEnabled() Indicates if redo logging is enabled during a masking operation.
Boolean	getIsRefreshStatsEnabled() Indicates if statistics gathering is enabled.
String	getParallelDegree() Specifies options to enable parallel execution when running data masking.
String	getPostMaskingScript() A post-masking script, which can contain SQL and PL/SQL statements.
String	getPreMaskingScript() A pre-masking script, which can contain SQL and PL/SQL statements.
MaskingPolicy.Recompile	getRecompile() Specifies how to recompile invalid objects post data masking.
int	hashCode()
CreateMaskingPolicyDetails.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

CreateMaskingPolicyDetails

@Deprecated
 @ConstructorProperties(value={"displayName","compartmentId","description","isDropTempTablesEnabled","isRedoLoggingEnabled","isRefreshStatsEnabled","parallelDegree","recompile","preMaskingScript","postMaskingScript","columnSource","freeformTags","definedTags"})
public CreateMaskingPolicyDetails(String displayName,
                                                                                                                                                                                                                                                                                                                    String compartmentId,
                                                                                                                                                                                                                                                                                                                    String description,
                                                                                                                                                                                                                                                                                                                    Boolean isDropTempTablesEnabled,
                                                                                                                                                                                                                                                                                                                    Boolean isRedoLoggingEnabled,
                                                                                                                                                                                                                                                                                                                    Boolean isRefreshStatsEnabled,
                                                                                                                                                                                                                                                                                                                    String parallelDegree,
                                                                                                                                                                                                                                                                                                                    MaskingPolicy.Recompile recompile,
                                                                                                                                                                                                                                                                                                                    String preMaskingScript,
                                                                                                                                                                                                                                                                                                                    String postMaskingScript,
                                                                                                                                                                                                                                                                                                                    CreateColumnSourceDetails columnSource,
                                                                                                                                                                                                                                                                                                                    Map<String,String> freeformTags,
                                                                                                                                                                                                                                                                                                                    Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static CreateMaskingPolicyDetails.Builder builder()

Create a new builder.

toBuilder

public CreateMaskingPolicyDetails.Builder toBuilder()

getDisplayName

public String getDisplayName()

The display name of the masking policy. The name does not have to be unique, and it’s changeable.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment where the masking policy should be created.

Returns:

the value

getDescription

public String getDescription()

The description of the masking policy.

Returns:

the value

getIsDropTempTablesEnabled

public Boolean getIsDropTempTablesEnabled()

Indicates if the temporary tables created during a masking operation should be dropped after masking. It’s enabled by default. Set this attribute to false to preserve the temporary tables. Masking creates temporary tables that map the original sensitive data values to mask values. By default, these temporary tables are dropped after masking. 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.

Returns:

the value

getIsRedoLoggingEnabled

public Boolean getIsRedoLoggingEnabled()

Indicates if redo logging is enabled during a masking operation. It’s disabled by default. Set this attribute to true to enable redo logging. By default, 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.

Returns:

the value

getIsRefreshStatsEnabled

public Boolean getIsRefreshStatsEnabled()

Indicates if statistics gathering is enabled. It’s enabled by default. Set this attribute to false to disable statistics gathering. The masking process gathers statistics on masked database tables after masking completes.

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.

Returns:

the value

getRecompile

public MaskingPolicy.Recompile 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.

Returns:

the value

getPreMaskingScript

public String getPreMaskingScript()

A pre-masking script, which can contain SQL and PL/SQL statements. It’s executed before the core masking script generated using the masking policy. It’s usually used to perform any preparation or prerequisite work before masking data.

Returns:

the value

getPostMaskingScript

public String getPostMaskingScript()

A post-masking script, which can contain SQL and PL/SQL statements. It’s executed after the core masking script generated using the masking policy. It’s usually used to perform additional transformation or cleanup work after masking.

Returns:

the value

getColumnSource

public CreateColumnSourceDetails getColumnSource()

getFreeformTags

public Map<String,String> getFreeformTags()

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {"Department": "Finance"}

Returns:

the value

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags

Example: {"Operations": {"CostCenter": "42"}}

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