com.google.privacy.dlp.v2

Class CharacterMaskConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.privacy.dlp.v2.CharacterMaskConfig

All Implemented Interfaces:

CharacterMaskConfigOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CharacterMaskConfig.Builder Partially mask a string by replacing a given number of characters with a fixed character.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHARACTERS_TO_IGNORE_FIELD_NUMBER
static int	MASKING_CHARACTER_FIELD_NUMBER
static int	NUMBER_TO_MASK_FIELD_NUMBER
static int	REVERSE_ORDER_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
CharsToIgnore	getCharactersToIgnore(int index) When masking a string, items in this list will be skipped when replacing.
int	getCharactersToIgnoreCount() When masking a string, items in this list will be skipped when replacing.
java.util.List<CharsToIgnore>	getCharactersToIgnoreList() When masking a string, items in this list will be skipped when replacing.
CharsToIgnoreOrBuilder	getCharactersToIgnoreOrBuilder(int index) When masking a string, items in this list will be skipped when replacing.
java.util.List<? extends CharsToIgnoreOrBuilder>	getCharactersToIgnoreOrBuilderList() When masking a string, items in this list will be skipped when replacing.
static CharacterMaskConfig	getDefaultInstance()
CharacterMaskConfig	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
java.lang.String	getMaskingCharacter() Character to mask the sensitive values&mdash;for example, "*" for an alphabetic string such as name, or "0" for a numeric string such as ZIP code or credit card number.
ByteString	getMaskingCharacterBytes() Character to mask the sensitive values&mdash;for example, "*" for an alphabetic string such as name, or "0" for a numeric string such as ZIP code or credit card number.
int	getNumberToMask() Number of characters to mask.
Parser<CharacterMaskConfig>	getParserForType()
boolean	getReverseOrder() Mask characters in reverse order.
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static CharacterMaskConfig.Builder	newBuilder()
static CharacterMaskConfig.Builder	newBuilder(CharacterMaskConfig prototype)
CharacterMaskConfig.Builder	newBuilderForType()
protected CharacterMaskConfig.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static CharacterMaskConfig	parseDelimitedFrom(java.io.InputStream input)
static CharacterMaskConfig	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static CharacterMaskConfig	parseFrom(byte[] data)
static CharacterMaskConfig	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static CharacterMaskConfig	parseFrom(java.nio.ByteBuffer data)
static CharacterMaskConfig	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static CharacterMaskConfig	parseFrom(ByteString data)
static CharacterMaskConfig	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static CharacterMaskConfig	parseFrom(CodedInputStream input)
static CharacterMaskConfig	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static CharacterMaskConfig	parseFrom(java.io.InputStream input)
static CharacterMaskConfig	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<CharacterMaskConfig>	parser()
CharacterMaskConfig.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

MASKING_CHARACTER_FIELD_NUMBER

public static final int MASKING_CHARACTER_FIELD_NUMBER

See Also:

Constant Field Values

NUMBER_TO_MASK_FIELD_NUMBER

public static final int NUMBER_TO_MASK_FIELD_NUMBER

See Also:

Constant Field Values

REVERSE_ORDER_FIELD_NUMBER

public static final int REVERSE_ORDER_FIELD_NUMBER

See Also:

Constant Field Values

CHARACTERS_TO_IGNORE_FIELD_NUMBER

public static final int CHARACTERS_TO_IGNORE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getMaskingCharacter

public java.lang.String getMaskingCharacter()

 Character to mask the sensitive values—for example, "*" for an
 alphabetic string such as name, or "0" for a numeric string such as ZIP
 code or credit card number. String must have length 1. If not supplied, we
 will default to "*" for strings, 0 for digits.
 

string masking_character = 1;

Specified by:

getMaskingCharacter in interface CharacterMaskConfigOrBuilder

getMaskingCharacterBytes

public ByteString getMaskingCharacterBytes()

 Character to mask the sensitive values—for example, "*" for an
 alphabetic string such as name, or "0" for a numeric string such as ZIP
 code or credit card number. String must have length 1. If not supplied, we
 will default to "*" for strings, 0 for digits.
 

string masking_character = 1;

Specified by:

getMaskingCharacterBytes in interface CharacterMaskConfigOrBuilder

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.
 

int32 number_to_mask = 2;

Specified by:

getNumberToMask in interface CharacterMaskConfigOrBuilder

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
 1234-5678-9012-3456 -> 00000000000000-3456
 If `masking_character` is '*', `number_to_mask` is 3, and `reverse_order`
 is true, then 12345 -> 12***
 

bool reverse_order = 3;

Specified by:

getReverseOrder in interface CharacterMaskConfigOrBuilder

getCharactersToIgnoreList

public java.util.List<CharsToIgnore> getCharactersToIgnoreList()

 When masking a string, items in this list will be skipped when replacing.
 For example, if your string is 555-555-5555 and you ask us to skip `-` and
 mask 5 chars with * we would produce ***-*55-5555.
 

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

Specified by:

getCharactersToIgnoreList in interface CharacterMaskConfigOrBuilder

getCharactersToIgnoreOrBuilderList

public java.util.List<? extends CharsToIgnoreOrBuilder> getCharactersToIgnoreOrBuilderList()

 When masking a string, items in this list will be skipped when replacing.
 For example, if your string is 555-555-5555 and you ask us to skip `-` and
 mask 5 chars with * we would produce ***-*55-5555.
 

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

Specified by:

getCharactersToIgnoreOrBuilderList in interface CharacterMaskConfigOrBuilder

getCharactersToIgnoreCount

public int getCharactersToIgnoreCount()

 When masking a string, items in this list will be skipped when replacing.
 For example, if your string is 555-555-5555 and you ask us to skip `-` and
 mask 5 chars with * we would produce ***-*55-5555.
 

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

Specified by:

getCharactersToIgnoreCount in interface CharacterMaskConfigOrBuilder

getCharactersToIgnore

public CharsToIgnore getCharactersToIgnore(int index)

 When masking a string, items in this list will be skipped when replacing.
 For example, if your string is 555-555-5555 and you ask us to skip `-` and
 mask 5 chars with * we would produce ***-*55-5555.
 

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

Specified by:

getCharactersToIgnore in interface CharacterMaskConfigOrBuilder

getCharactersToIgnoreOrBuilder

public CharsToIgnoreOrBuilder getCharactersToIgnoreOrBuilder(int index)

 When masking a string, items in this list will be skipped when replacing.
 For example, if your string is 555-555-5555 and you ask us to skip `-` and
 mask 5 chars with * we would produce ***-*55-5555.
 

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

Specified by:

getCharactersToIgnoreOrBuilder in interface CharacterMaskConfigOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static CharacterMaskConfig parseFrom(java.nio.ByteBuffer data)
                                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CharacterMaskConfig parseFrom(java.nio.ByteBuffer data,
                                            ExtensionRegistryLite extensionRegistry)
                                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CharacterMaskConfig parseFrom(ByteString data)
                                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CharacterMaskConfig parseFrom(ByteString data,
                                            ExtensionRegistryLite extensionRegistry)
                                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CharacterMaskConfig parseFrom(byte[] data)
                                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CharacterMaskConfig parseFrom(byte[] data,
                                            ExtensionRegistryLite extensionRegistry)
                                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CharacterMaskConfig parseFrom(java.io.InputStream input)
                                     throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static CharacterMaskConfig parseFrom(java.io.InputStream input,
                                            ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static CharacterMaskConfig parseDelimitedFrom(java.io.InputStream input)
                                              throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static CharacterMaskConfig parseDelimitedFrom(java.io.InputStream input,
                                                     ExtensionRegistryLite extensionRegistry)
                                              throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static CharacterMaskConfig parseFrom(CodedInputStream input)
                                     throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static CharacterMaskConfig parseFrom(CodedInputStream input,
                                            ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public CharacterMaskConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static CharacterMaskConfig.Builder newBuilder()

newBuilder

public static CharacterMaskConfig.Builder newBuilder(CharacterMaskConfig prototype)

toBuilder

public CharacterMaskConfig.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected CharacterMaskConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static CharacterMaskConfig getDefaultInstance()

parser

public static Parser<CharacterMaskConfig> parser()

getParserForType

public Parser<CharacterMaskConfig> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public CharacterMaskConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder