Class CharacterMaskConfig.Builder (3.53.0) 

public static final class CharacterMaskConfig.Builder extends GeneratedMessageV3.Builder<CharacterMaskConfig.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CharacterMaskConfig.Builder

Static Methods

getDescriptor()

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

Methods

addAllCharactersToIgnore(Iterable<? extends CharsToIgnore> values)

public CharacterMaskConfig.Builder addAllCharactersToIgnore(Iterable<? extends CharsToIgnore> values)

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
values Iterable<? extends com.google.privacy.dlp.v2.CharsToIgnore>
Returns
Type Description
CharacterMaskConfig.Builder

addCharactersToIgnore(CharsToIgnore value)

public CharacterMaskConfig.Builder addCharactersToIgnore(CharsToIgnore value)

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
value CharsToIgnore
Returns
Type Description
CharacterMaskConfig.Builder

addCharactersToIgnore(CharsToIgnore.Builder builderForValue)

public CharacterMaskConfig.Builder addCharactersToIgnore(CharsToIgnore.Builder builderForValue)

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
builderForValue CharsToIgnore.Builder
Returns
Type Description
CharacterMaskConfig.Builder

addCharactersToIgnore(int index, CharsToIgnore value)

public CharacterMaskConfig.Builder addCharactersToIgnore(int index, CharsToIgnore value)

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;

Parameters
Name Description
index int
value CharsToIgnore
Returns
Type Description
CharacterMaskConfig.Builder

addCharactersToIgnore(int index, CharsToIgnore.Builder builderForValue)

public CharacterMaskConfig.Builder addCharactersToIgnore(int index, CharsToIgnore.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue CharsToIgnore.Builder
Returns
Type Description
CharacterMaskConfig.Builder

addCharactersToIgnoreBuilder()

public CharsToIgnore.Builder addCharactersToIgnoreBuilder()

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
CharsToIgnore.Builder

addCharactersToIgnoreBuilder(int index)

public CharsToIgnore.Builder addCharactersToIgnoreBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CharacterMaskConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CharacterMaskConfig.Builder
Overrides

build()

public CharacterMaskConfig build()
Returns
Type Description
CharacterMaskConfig

buildPartial()

public CharacterMaskConfig buildPartial()
Returns
Type Description
CharacterMaskConfig

clear()

public CharacterMaskConfig.Builder clear()
Returns
Type Description
CharacterMaskConfig.Builder
Overrides

clearCharactersToIgnore()

public CharacterMaskConfig.Builder clearCharactersToIgnore()

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
CharacterMaskConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public CharacterMaskConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CharacterMaskConfig.Builder
Overrides

clearMaskingCharacter()

public CharacterMaskConfig.Builder clearMaskingCharacter()

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
CharacterMaskConfig.Builder

This builder for chaining.

clearNumberToMask()

public CharacterMaskConfig.Builder clearNumberToMask()

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
CharacterMaskConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CharacterMaskConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CharacterMaskConfig.Builder
Overrides

clearReverseOrder()

public CharacterMaskConfig.Builder clearReverseOrder()

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
CharacterMaskConfig.Builder

This builder for chaining.

clone()

public CharacterMaskConfig.Builder clone()
Returns
Type Description
CharacterMaskConfig.Builder
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

getCharactersToIgnoreBuilder(int index)

public CharsToIgnore.Builder getCharactersToIgnoreBuilder(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.Builder

getCharactersToIgnoreBuilderList()

public List<CharsToIgnore.Builder> getCharactersToIgnoreBuilderList()

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<Builder>

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CharacterMaskConfig other)

public CharacterMaskConfig.Builder mergeFrom(CharacterMaskConfig other)
Parameter
Name Description
other CharacterMaskConfig
Returns
Type Description
CharacterMaskConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CharacterMaskConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CharacterMaskConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CharacterMaskConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CharacterMaskConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CharacterMaskConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CharacterMaskConfig.Builder
Overrides

removeCharactersToIgnore(int index)

public CharacterMaskConfig.Builder removeCharactersToIgnore(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
CharacterMaskConfig.Builder

setCharactersToIgnore(int index, CharsToIgnore value)

public CharacterMaskConfig.Builder setCharactersToIgnore(int index, CharsToIgnore value)

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;

Parameters
Name Description
index int
value CharsToIgnore
Returns
Type Description
CharacterMaskConfig.Builder

setCharactersToIgnore(int index, CharsToIgnore.Builder builderForValue)

public CharacterMaskConfig.Builder setCharactersToIgnore(int index, CharsToIgnore.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue CharsToIgnore.Builder
Returns
Type Description
CharacterMaskConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CharacterMaskConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CharacterMaskConfig.Builder
Overrides

setMaskingCharacter(String value)

public CharacterMaskConfig.Builder setMaskingCharacter(String value)

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;

Parameter
Name Description
value String

The maskingCharacter to set.
Returns
Type Description
CharacterMaskConfig.Builder

This builder for chaining.

setMaskingCharacterBytes(ByteString value)

public CharacterMaskConfig.Builder setMaskingCharacterBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for maskingCharacter to set.
Returns
Type Description
CharacterMaskConfig.Builder

This builder for chaining.

setNumberToMask(int value)

public CharacterMaskConfig.Builder setNumberToMask(int value)

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;

Parameter
Name Description
value int

The numberToMask to set.
Returns
Type Description
CharacterMaskConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CharacterMaskConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CharacterMaskConfig.Builder
Overrides

setReverseOrder(boolean value)

public CharacterMaskConfig.Builder setReverseOrder(boolean value)

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;

Parameter
Name Description
value boolean

The reverseOrder to set.
Returns
Type Description
CharacterMaskConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CharacterMaskConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CharacterMaskConfig.Builder
Overrides