com.oracle.bmc.datasafe.model

Class LibraryMaskingFormat

java.lang.Object

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

com.oracle.bmc.datasafe.model.LibraryMaskingFormat

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

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.
Note: Objects should always be created or deserialized using the LibraryMaskingFormat.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 LibraryMaskingFormat.Builder, which maintain a set of all explicitly set fields called LibraryMaskingFormat.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	LibraryMaskingFormat.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
LibraryMaskingFormat(String id, String compartmentId, String displayName, Date timeCreated, Date timeUpdated, MaskingLifecycleState lifecycleState, String description, List<String> sensitiveTypeIds, LibraryMaskingFormatSource source, List<FormatEntry> formatEntries, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags) Deprecated.

Method Summary

Modifier and Type	Method and Description
static LibraryMaskingFormat.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getCompartmentId() The OCID of the compartment that contains the library masking format.
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getDescription() The description of the library masking format.
String	getDisplayName() The display name of the library masking format.
List<FormatEntry>	getFormatEntries() An array of format entries.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
String	getId() The OCID of the library masking format.
MaskingLifecycleState	getLifecycleState() The current state of the library masking format.
List<String>	getSensitiveTypeIds() An array of OCIDs of the sensitive types compatible with the library masking format.
LibraryMaskingFormatSource	getSource() Specifies whether the library masking format is user-defined or predefined.
Date	getTimeCreated() The date and time the library masking format was created, in the format defined by RFC3339
Date	getTimeUpdated() The date and time the library masking format was updated, in the format defined by RFC3339
int	hashCode()
LibraryMaskingFormat.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

LibraryMaskingFormat

@Deprecated
 @ConstructorProperties(value={"id","compartmentId","displayName","timeCreated","timeUpdated","lifecycleState","description","sensitiveTypeIds","source","formatEntries","freeformTags","definedTags"})
public LibraryMaskingFormat(String id,
                                                                                                                                                                                                                                                String compartmentId,
                                                                                                                                                                                                                                                String displayName,
                                                                                                                                                                                                                                                Date timeCreated,
                                                                                                                                                                                                                                                Date timeUpdated,
                                                                                                                                                                                                                                                MaskingLifecycleState lifecycleState,
                                                                                                                                                                                                                                                String description,
                                                                                                                                                                                                                                                List<String> sensitiveTypeIds,
                                                                                                                                                                                                                                                LibraryMaskingFormatSource source,
                                                                                                                                                                                                                                                List<FormatEntry> formatEntries,
                                                                                                                                                                                                                                                Map<String,String> freeformTags,
                                                                                                                                                                                                                                                Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static LibraryMaskingFormat.Builder builder()

Create a new builder.

toBuilder

public LibraryMaskingFormat.Builder toBuilder()

getId

public String getId()

The OCID of the library masking format.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that contains the library masking format.

Returns:

the value

getDisplayName

public String getDisplayName()

The display name of the library masking format.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the library masking format was created, in the format defined by RFC3339

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The date and time the library masking format was updated, in the format defined by RFC3339

Returns:

the value

getLifecycleState

public MaskingLifecycleState getLifecycleState()

The current state of the library masking format.

Returns:

the value

getDescription

public String getDescription()

The description of the library masking format.

Returns:

the value

getSensitiveTypeIds

public List<String> getSensitiveTypeIds()

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

Returns:

the value

getSource

public LibraryMaskingFormatSource getSource()

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

Returns:

the value

getFormatEntries

public List<FormatEntry> getFormatEntries()

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

Returns:

the value

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