Class CharacterMaskConfig (3.51.0)

public final class CharacterMaskConfig extends GeneratedMessageV3 implements CharacterMaskConfigOrBuilder

Partially mask a string by replacing a given number of characters with a fixed character. Masking can start from the beginning or end of the string. This can be used on data of any type (numbers, longs, and so on) and when de-identifying structured data we'll attempt to preserve the original data's type. (This allows you to take a long like 123 and modify it to a string like **3.

Protobuf type google.privacy.dlp.v2.CharacterMaskConfig

Static Fields

CHARACTERS_TO_IGNORE_FIELD_NUMBER

public static final int CHARACTERS_TO_IGNORE_FIELD_NUMBER
Field Value
Type Description
int

MASKING_CHARACTER_FIELD_NUMBER

public static final int MASKING_CHARACTER_FIELD_NUMBER
Field Value
Type Description
int

NUMBER_TO_MASK_FIELD_NUMBER

public static final int NUMBER_TO_MASK_FIELD_NUMBER
Field Value
Type Description
int

REVERSE_ORDER_FIELD_NUMBER

public static final int REVERSE_ORDER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CharacterMaskConfig getDefaultInstance()
Returns
Type Description
CharacterMaskConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CharacterMaskConfig.Builder newBuilder()
Returns
Type Description
CharacterMaskConfig.Builder

newBuilder(CharacterMaskConfig prototype)

public static CharacterMaskConfig.Builder newBuilder(CharacterMaskConfig prototype)
Parameter
Name Description
prototype CharacterMaskConfig
Returns
Type Description
CharacterMaskConfig.Builder

parseDelimitedFrom(InputStream input)

public static CharacterMaskConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CharacterMaskConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CharacterMaskConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CharacterMaskConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CharacterMaskConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CharacterMaskConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CharacterMaskConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CharacterMaskConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CharacterMaskConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CharacterMaskConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CharacterMaskConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CharacterMaskConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CharacterMaskConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CharacterMaskConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CharacterMaskConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CharacterMaskConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CharacterMaskConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CharacterMaskConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CharacterMaskConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CharacterMaskConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CharacterMaskConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CharacterMaskConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CharacterMaskConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CharacterMaskConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CharacterMaskConfig> parser()
Returns
Type Description
Parser<CharacterMaskConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCharactersToIgnore(int index)

public CharsToIgnore getCharactersToIgnore(int index)

When masking a string, items in this list will be skipped when replacing characters. For example, if the input string is 555-555-5555 and you instruct Cloud DLP to skip - and mask 5 characters with , Cloud DLP returns -5-5555.

repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;

Parameter
Name Description
index int
Returns
Type Description
CharsToIgnore

getCharactersToIgnoreCount()

public int getCharactersToIgnoreCount()

When masking a string, items in this list will be skipped when replacing characters. For example, if the input string is 555-555-5555 and you instruct Cloud DLP to skip - and mask 5 characters with , Cloud DLP returns -5-5555.

repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;

Returns
Type Description
int

getCharactersToIgnoreList()

public List<CharsToIgnore> getCharactersToIgnoreList()

When masking a string, items in this list will be skipped when replacing characters. For example, if the input string is 555-555-5555 and you instruct Cloud DLP to skip - and mask 5 characters with , Cloud DLP returns -5-5555.

repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;

Returns
Type Description
List<CharsToIgnore>

getCharactersToIgnoreOrBuilder(int index)

public CharsToIgnoreOrBuilder getCharactersToIgnoreOrBuilder(int index)

When masking a string, items in this list will be skipped when replacing characters. For example, if the input string is 555-555-5555 and you instruct Cloud DLP to skip - and mask 5 characters with , Cloud DLP returns -5-5555.

repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;

Parameter
Name Description
index int
Returns
Type Description
CharsToIgnoreOrBuilder

getCharactersToIgnoreOrBuilderList()

public List<? extends CharsToIgnoreOrBuilder> getCharactersToIgnoreOrBuilderList()

When masking a string, items in this list will be skipped when replacing characters. For example, if the input string is 555-555-5555 and you instruct Cloud DLP to skip - and mask 5 characters with , Cloud DLP returns -5-5555.

repeated .google.privacy.dlp.v2.CharsToIgnore characters_to_ignore = 4;

Returns
Type Description
List<? extends com.google.privacy.dlp.v2.CharsToIgnoreOrBuilder>

getDefaultInstanceForType()

public CharacterMaskConfig getDefaultInstanceForType()
Returns
Type Description
CharacterMaskConfig

getMaskingCharacter()

public String getMaskingCharacter()

Character to use to mask the sensitive values&mdash;for example, for an alphabetic string such as a name, or 0 for a numeric string such as ZIP code or credit card number. This string must have a length of 1. If not supplied, this value defaults to for strings, and 0 for digits.

string masking_character = 1;

Returns
Type Description
String

The maskingCharacter.

getMaskingCharacterBytes()

public ByteString getMaskingCharacterBytes()

Character to use to mask the sensitive values&mdash;for example, for an alphabetic string such as a name, or 0 for a numeric string such as ZIP code or credit card number. This string must have a length of 1. If not supplied, this value defaults to for strings, and 0 for digits.

string masking_character = 1;

Returns
Type Description
ByteString

The bytes for maskingCharacter.

getNumberToMask()

public int getNumberToMask()

Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally.

If number_to_mask is negative, this denotes inverse masking. Cloud DLP masks all but a number of characters. For example, suppose you have the following values:

  • masking_character is *
  • number_to_mask is -4
  • reverse_order is false
  • CharsToIgnore includes -
  • Input string is 1234-5678-9012-3456

    The resulting de-identified string is *---3456. Cloud DLP masks all but the last four characters. If reverse_order is true, all but the first four characters are masked as 1234---*.

int32 number_to_mask = 2;

Returns
Type Description
int

The numberToMask.

getParserForType()

public Parser<CharacterMaskConfig> getParserForType()
Returns
Type Description
Parser<CharacterMaskConfig>
Overrides

getReverseOrder()

public boolean getReverseOrder()

Mask characters in reverse order. For example, if masking_character is 0, number_to_mask is 14, and reverse_order is false, then the input string 1234-5678-9012-3456 is masked as 00000000000000-3456. If masking_character is , number_to_mask is 3, and reverse_order is true, then the string 12345 is masked as 12**.

bool reverse_order = 3;

Returns
Type Description
boolean

The reverseOrder.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CharacterMaskConfig.Builder newBuilderForType()
Returns
Type Description
CharacterMaskConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CharacterMaskConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CharacterMaskConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CharacterMaskConfig.Builder toBuilder()
Returns
Type Description
CharacterMaskConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException