Package com.oracle.bmc.ailanguage.model

Class PiiEntityMask

java.lang.Object

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

com.oracle.bmc.ailanguage.model.PiiEntityMasking

com.oracle.bmc.ailanguage.model.PiiEntityMask

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20221001")
public final class PiiEntityMask
extends PiiEntityMasking

Mask PII entities with the given masking character.
Note: Objects should always be created or deserialized using the PiiEntityMask.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 PiiEntityMask.Builder, which maintain a set of all explicitly set fields called PiiEntityMask.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	Description
static class	PiiEntityMask.Builder

Nested classes/interfaces inherited from class com.oracle.bmc.ailanguage.model.PiiEntityMasking

PiiEntityMasking.Mode

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	Description
PiiEntityMask(List<String> exclude, Boolean shouldDetect, String maskingCharacter, Integer leaveCharactersUnmasked, Boolean isUnmaskedFromEnd)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static PiiEntityMask.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Boolean	getIsUnmaskedFromEnd()	Unmask from the end.
Integer	getLeaveCharactersUnmasked()	Number of characters to leave unmasked.
String	getMaskingCharacter()	Masking character.
int	hashCode()
PiiEntityMask.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.ailanguage.model.PiiEntityMasking

getExclude, getShouldDetect

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

PiiEntityMask

@Deprecated
public PiiEntityMask(List<String> exclude,
                     Boolean shouldDetect,
                     String maskingCharacter,
                     Integer leaveCharactersUnmasked,
                     Boolean isUnmaskedFromEnd)

Deprecated.

Method Detail

builder

public static PiiEntityMask.Builder builder()

Create a new builder.

toBuilder

public PiiEntityMask.Builder toBuilder()

getMaskingCharacter

public String getMaskingCharacter()

Masking character.

By default, the character is an asterisk (*)

Returns:

the value

getLeaveCharactersUnmasked

public Integer getLeaveCharactersUnmasked()

Number of characters to leave unmasked.

By default, the whole entity is masked.

Returns:

the value

getIsUnmaskedFromEnd

public Boolean getIsUnmaskedFromEnd()

Unmask from the end.

By default, the whole entity is masked. This field works in concert with leaveCharactersUnmasked. For example, leaveCharactersUnmasked is 3 and isUnmaskedFromEnd is true, then if the entity is India the masked entity/result is **dia.

Returns:

the value

toString

public String toString()

Overrides:

toString in class PiiEntityMasking

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class PiiEntityMasking

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class PiiEntityMasking

hashCode

public int hashCode()

Overrides:

hashCode in class PiiEntityMasking