Class MaskingPolicy

Inheritance

object

MaskingPolicy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatasafeService.Models

Assembly: OCI.DotNetSDK.Datasafe.dll

Syntax

public class MaskingPolicy

Properties

ColumnSource

Declaration

[JsonProperty(PropertyName = "columnSource")]
public ColumnSourceDetails ColumnSource { get; set; }

Property Value

Type	Description
ColumnSourceDetails

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment that contains the masking policy.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	The description of the masking policy.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The display name of the masking policy.

Remarks

Required

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the masking policy.

Remarks

Required

IsDropTempTablesEnabled

Declaration

[Required(ErrorMessage = "IsDropTempTablesEnabled is required.")]
[JsonProperty(PropertyName = "isDropTempTablesEnabled")]
public bool? IsDropTempTablesEnabled { get; set; }

Property Value

Type	Description
bool?	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.

Type

Description

bool?

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.

Remarks

Required

IsRedoLoggingEnabled

Declaration

[Required(ErrorMessage = "IsRedoLoggingEnabled is required.")]
[JsonProperty(PropertyName = "isRedoLoggingEnabled")]
public bool? IsRedoLoggingEnabled { get; set; }

Property Value

Type	Description
bool?	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.

Type

Description

bool?

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.

Remarks

Required

IsRefreshStatsEnabled

Declaration

[Required(ErrorMessage = "IsRefreshStatsEnabled is required.")]
[JsonProperty(PropertyName = "isRefreshStatsEnabled")]
public bool? IsRefreshStatsEnabled { get; set; }

Property Value

Type	Description
bool?	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.

Remarks

Required

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public MaskingLifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
MaskingLifecycleState?	The current state of the masking policy.

Remarks

Required

ParallelDegree

Declaration

[Required(ErrorMessage = "ParallelDegree is required.")]
[JsonProperty(PropertyName = "parallelDegree")]
public string ParallelDegree { get; set; }

Property Value

Type	Description
string	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.

Type

Description

string

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.

Remarks

Required

PostMaskingScript

Declaration

[JsonProperty(PropertyName = "postMaskingScript")]
public string PostMaskingScript { get; set; }

Property Value

Type	Description
string	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.

PreMaskingScript

Declaration

[JsonProperty(PropertyName = "preMaskingScript")]
public string PreMaskingScript { get; set; }

Property Value

Type	Description
string	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.

Recompile

Declaration

[Required(ErrorMessage = "Recompile is required.")]
[JsonProperty(PropertyName = "recompile")]
[JsonConverter(typeof(ResponseEnumConverter))]
public MaskingPolicy.RecompileEnum? Recompile { get; set; }

Property Value

Type	Description
MaskingPolicy.RecompileEnum?	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.

Remarks

Required

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the masking policy was created, in the format defined by RFC3339.

Remarks

Required

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the masking policy was last updated, in the format defined by RFC3339

Remarks

Required