Show / Hide Table of Contents

Class LibraryMaskingFormat

A library masking format is a masking format stored in an Oracle Cloud Infrastructure compartment and can be used in multiple masking policies. If you want to use the same masking logic for multiple masking columns or even in multiple masking policies, you can create a library masking format and assign it to masking columns as needed. It helps you avoid defining the same masking logic again and again.
Oracle Data Safe provides a set of predefined library masking formats to mask common sensitive and personal data, such as names, national identifiers, credit card numbers, and phone numbers. To meet your specific requirements, you can easily create new library masking formats and use them in your masking policies.

Inheritance
object
LibraryMaskingFormat
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 LibraryMaskingFormat

Properties

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 library masking format.

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 library masking format.

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 library masking format.

Remarks

Required

FormatEntries

Declaration
[JsonProperty(PropertyName = "formatEntries")]
public List<FormatEntry> FormatEntries { get; set; }
Property Value
Type Description
List<FormatEntry>

An array of format entries. The combined output of all the format entries is used for masking.

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 library masking format.

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 library masking format.

Remarks

Required

SensitiveTypeIds

Declaration
[JsonProperty(PropertyName = "sensitiveTypeIds")]
public List<string> SensitiveTypeIds { get; set; }
Property Value
Type Description
List<string>

An array of OCIDs of the sensitive types compatible with the library masking format.

Source

Declaration
[Required(ErrorMessage = "Source is required.")]
[JsonProperty(PropertyName = "source")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LibraryMaskingFormatSource? Source { get; set; }
Property Value
Type Description
LibraryMaskingFormatSource?

Specifies whether the library masking format is user-defined or predefined.

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 library masking format 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 library masking format was updated, in the format defined by RFC3339

Remarks

Required

In this article
Back to top