Class CharacterMaskConfig (3.17.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
TypeDescription
int

MASKING_CHARACTER_FIELD_NUMBER

public static final int MASKING_CHARACTER_FIELD_NUMBER
Field Value
TypeDescription
int

NUMBER_TO_MASK_FIELD_NUMBER

public static final int NUMBER_TO_MASK_FIELD_NUMBER
Field Value
TypeDescription
int

REVERSE_ORDER_FIELD_NUMBER

public static final int REVERSE_ORDER_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CharacterMaskConfig getDefaultInstance()
Returns
TypeDescription
CharacterMaskConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CharacterMaskConfig.Builder newBuilder()
Returns
TypeDescription
CharacterMaskConfig.Builder

newBuilder(CharacterMaskConfig prototype)

public static CharacterMaskConfig.Builder newBuilder(CharacterMaskConfig prototype)
Parameter
NameDescription
prototypeCharacterMaskConfig
Returns
TypeDescription
CharacterMaskConfig.Builder

parseDelimitedFrom(InputStream input)

public static CharacterMaskConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CharacterMaskConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CharacterMaskConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CharacterMaskConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CharacterMaskConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CharacterMaskConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CharacterMaskConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CharacterMaskConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CharacterMaskConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CharacterMaskConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CharacterMaskConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CharacterMaskConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CharacterMaskConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CharacterMaskConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CharacterMaskConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CharacterMaskConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CharacterMaskConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CharacterMaskConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CharacterMaskConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CharacterMaskConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CharacterMaskConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CharacterMaskConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CharacterMaskConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CharacterMaskConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CharacterMaskConfig> parser()
Returns
TypeDescription
Parser<CharacterMaskConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.privacy.dlp.v2.CharsToIgnoreOrBuilder>

getDefaultInstanceForType()

public CharacterMaskConfig getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The numberToMask.

getParserForType()

public Parser<CharacterMaskConfig> getParserForType()
Returns
TypeDescription
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
TypeDescription
boolean

The reverseOrder.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CharacterMaskConfig.Builder newBuilderForType()
Returns
TypeDescription
CharacterMaskConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CharacterMaskConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CharacterMaskConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CharacterMaskConfig.Builder toBuilder()
Returns
TypeDescription
CharacterMaskConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException