public static final class CharacterMaskConfig.Builder extends GeneratedMessageV3.Builder<CharacterMaskConfig.Builder> implements CharacterMaskConfigOrBuilderPartially 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.BuilderImplements
CharacterMaskConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| 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;
| Name | Description |
| values | Iterable<? extends com.google.privacy.dlp.v2.CharsToIgnore> |
| 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;
| Name | Description |
| value | CharsToIgnore |
| 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;
| Name | Description |
| builderForValue | CharsToIgnore.Builder |
| 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;
| Name | Description |
| index | int |
| value | CharsToIgnore |
| 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;
| Name | Description |
| index | int |
| builderForValue | CharsToIgnore.Builder |
| 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;
| 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;
| Name | Description |
| index | int |
| Type | Description |
| CharsToIgnore.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CharacterMaskConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| CharacterMaskConfig.Builder |
build()
public CharacterMaskConfig build()| Type | Description |
| CharacterMaskConfig |
buildPartial()
public CharacterMaskConfig buildPartial()| Type | Description |
| CharacterMaskConfig |
clear()
public CharacterMaskConfig.Builder clear()| Type | Description |
| CharacterMaskConfig.Builder |
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;
| Type | Description |
| CharacterMaskConfig.Builder |
clearField(Descriptors.FieldDescriptor field)
public CharacterMaskConfig.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| CharacterMaskConfig.Builder |
clearMaskingCharacter()
public CharacterMaskConfig.Builder clearMaskingCharacter() Character to use to mask the sensitive values—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;
| 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_characteris*number_to_maskis-4reverse_orderisfalseCharsToIgnoreincludes-- Input string is
1234-5678-9012-3456The resulting de-identified string is*---3456. Cloud DLP masks all but the last four characters. Ifreverse_orderistrue, all but the first four characters are masked as1234---*.
int32 number_to_mask = 2;
| Type | Description |
| CharacterMaskConfig.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public CharacterMaskConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| CharacterMaskConfig.Builder |
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;
| Type | Description |
| CharacterMaskConfig.Builder | This builder for chaining. |
clone()
public CharacterMaskConfig.Builder clone()| Type | Description |
| CharacterMaskConfig.Builder |
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;
| Name | Description |
| index | int |
| 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;
| Name | Description |
| index | int |
| 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;
| 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;
| 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;
| 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;
| Name | Description |
| index | int |
| 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;
| Type | Description |
| List<? extends com.google.privacy.dlp.v2.CharsToIgnoreOrBuilder> |
getDefaultInstanceForType()
public CharacterMaskConfig getDefaultInstanceForType()| Type | Description |
| CharacterMaskConfig |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getMaskingCharacter()
public String getMaskingCharacter() Character to use to mask the sensitive values—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;
| Type | Description |
| String | The maskingCharacter. |
getMaskingCharacterBytes()
public ByteString getMaskingCharacterBytes() Character to use to mask the sensitive values—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;
| 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_characteris*number_to_maskis-4reverse_orderisfalseCharsToIgnoreincludes-- Input string is
1234-5678-9012-3456The resulting de-identified string is*---3456. Cloud DLP masks all but the last four characters. Ifreverse_orderistrue, all but the first four characters are masked as1234---*.
int32 number_to_mask = 2;
| 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;
| Type | Description |
| boolean | The reverseOrder. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(CharacterMaskConfig other)
public CharacterMaskConfig.Builder mergeFrom(CharacterMaskConfig other)| Name | Description |
| other | CharacterMaskConfig |
| Type | Description |
| CharacterMaskConfig.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CharacterMaskConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| CharacterMaskConfig.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public CharacterMaskConfig.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| CharacterMaskConfig.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CharacterMaskConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| CharacterMaskConfig.Builder |
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;
| Name | Description |
| index | int |
| 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;
| Name | Description |
| index | int |
| value | CharsToIgnore |
| 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;
| Name | Description |
| index | int |
| builderForValue | CharsToIgnore.Builder |
| Type | Description |
| CharacterMaskConfig.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public CharacterMaskConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| CharacterMaskConfig.Builder |
setMaskingCharacter(String value)
public CharacterMaskConfig.Builder setMaskingCharacter(String value) Character to use to mask the sensitive values—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;
| Name | Description |
| value | StringThe maskingCharacter to set. |
| 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—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;
| Name | Description |
| value | ByteStringThe bytes for maskingCharacter to set. |
| 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_characteris*number_to_maskis-4reverse_orderisfalseCharsToIgnoreincludes-- Input string is
1234-5678-9012-3456The resulting de-identified string is*---3456. Cloud DLP masks all but the last four characters. Ifreverse_orderistrue, all but the first four characters are masked as1234---*.
int32 number_to_mask = 2;
| Name | Description |
| value | intThe numberToMask to set. |
| 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)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| CharacterMaskConfig.Builder |
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;
| Name | Description |
| value | booleanThe reverseOrder to set. |
| Type | Description |
| CharacterMaskConfig.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final CharacterMaskConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| CharacterMaskConfig.Builder |