Class CharacterMaskConfig (3.6.5)

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

Inheritance

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

Implements

CharacterMaskConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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()

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

Returns

Type	Description
int

getCharactersToIgnoreList()

public List<CharsToIgnore> getCharactersToIgnoreList()

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

Returns

Type	Description
List<CharsToIgnore>

getCharactersToIgnoreOrBuilder(int index)

public CharsToIgnoreOrBuilder getCharactersToIgnoreOrBuilder(int index)

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()

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—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()

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.

int32 number_to_mask = 2;

Returns

Type	Description
int	The numberToMask.

getParserForType()

public Parser<CharacterMaskConfig> getParserForType()

Returns

Type	Description
Parser<CharacterMaskConfig>

Overrides

GeneratedMessageV3.getParserForType()

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

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	`UnusedPrivateParameter`

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public CharacterMaskConfig.Builder toBuilder()

Returns

Type	Description
CharacterMaskConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException