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, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class CharacterMaskConfig
extends com.google.protobuf.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 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
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field	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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`CharsToIgnore`	`getCharactersToIgnore(int index)`	When masking a string, items in this list will be skipped when replacing characters.
`int`	`getCharactersToIgnoreCount()`	When masking a string, items in this list will be skipped when replacing characters.
`List<CharsToIgnore>`	`getCharactersToIgnoreList()`	When masking a string, items in this list will be skipped when replacing characters.
`CharsToIgnoreOrBuilder`	`getCharactersToIgnoreOrBuilder(int index)`	When masking a string, items in this list will be skipped when replacing characters.
`List<? extends CharsToIgnoreOrBuilder>`	`getCharactersToIgnoreOrBuilderList()`	When masking a string, items in this list will be skipped when replacing characters.
`static CharacterMaskConfig`	`getDefaultInstance()`
`CharacterMaskConfig`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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.
`com.google.protobuf.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.
`int`	`getNumberToMask()`	Number of characters to mask.
`com.google.protobuf.Parser<CharacterMaskConfig>`	`getParserForType()`
`boolean`	`getReverseOrder()`	Mask characters in reverse order.
`int`	`getSerializedSize()`
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static CharacterMaskConfig.Builder`	`newBuilder()`
`static CharacterMaskConfig.Builder`	`newBuilder(CharacterMaskConfig prototype)`
`CharacterMaskConfig.Builder`	`newBuilderForType()`
`protected CharacterMaskConfig.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static CharacterMaskConfig`	`parseDelimitedFrom(InputStream input)`
`static CharacterMaskConfig`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CharacterMaskConfig`	`parseFrom(byte[] data)`
`static CharacterMaskConfig`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CharacterMaskConfig`	`parseFrom(com.google.protobuf.ByteString data)`
`static CharacterMaskConfig`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CharacterMaskConfig`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static CharacterMaskConfig`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CharacterMaskConfig`	`parseFrom(InputStream input)`
`static CharacterMaskConfig`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CharacterMaskConfig`	`parseFrom(ByteBuffer data)`
`static CharacterMaskConfig`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<CharacterMaskConfig>`	`parser()`
`CharacterMaskConfig.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

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

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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;

Specified by:: getMaskingCharacter in interface CharacterMaskConfigOrBuilder
Returns:: The maskingCharacter.

getMaskingCharacterBytes

public com.google.protobuf.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;

Specified by:: getMaskingCharacterBytes in interface CharacterMaskConfigOrBuilder
Returns:: 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;

Specified by:: getNumberToMask in interface CharacterMaskConfigOrBuilder
Returns:: 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;

Specified by:: getReverseOrder in interface CharacterMaskConfigOrBuilder
Returns:: The reverseOrder.