CharacterMaskConfig.Builder (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<CharacterMaskConfig.Builder>
    - - com.google.privacy.dlp.v2.CharacterMaskConfig.Builder

All Implemented Interfaces:: CharacterMaskConfigOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:: CharacterMaskConfig

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CharacterMaskConfig.Builder`	`addAllCharactersToIgnore(java.lang.Iterable<? extends CharsToIgnore> values)` When masking a string, items in this list will be skipped when replacing.
`CharacterMaskConfig.Builder`	`addCharactersToIgnore(CharsToIgnore.Builder builderForValue)` When masking a string, items in this list will be skipped when replacing.
`CharacterMaskConfig.Builder`	`addCharactersToIgnore(CharsToIgnore value)` When masking a string, items in this list will be skipped when replacing.
`CharacterMaskConfig.Builder`	`addCharactersToIgnore(int index, CharsToIgnore.Builder builderForValue)` When masking a string, items in this list will be skipped when replacing.
`CharacterMaskConfig.Builder`	`addCharactersToIgnore(int index, CharsToIgnore value)` When masking a string, items in this list will be skipped when replacing.
`CharsToIgnore.Builder`	`addCharactersToIgnoreBuilder()` When masking a string, items in this list will be skipped when replacing.
`CharsToIgnore.Builder`	`addCharactersToIgnoreBuilder(int index)` When masking a string, items in this list will be skipped when replacing.
`CharacterMaskConfig.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`CharacterMaskConfig`	`build()`
`CharacterMaskConfig`	`buildPartial()`
`CharacterMaskConfig.Builder`	`clear()`
`CharacterMaskConfig.Builder`	`clearCharactersToIgnore()` When masking a string, items in this list will be skipped when replacing.
`CharacterMaskConfig.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`CharacterMaskConfig.Builder`	`clearMaskingCharacter()` 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.
`CharacterMaskConfig.Builder`	`clearNumberToMask()` Number of characters to mask.
`CharacterMaskConfig.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`CharacterMaskConfig.Builder`	`clearReverseOrder()` Mask characters in reverse order.
`CharacterMaskConfig.Builder`	`clone()`
`CharsToIgnore`	`getCharactersToIgnore(int index)` When masking a string, items in this list will be skipped when replacing.
`CharsToIgnore.Builder`	`getCharactersToIgnoreBuilder(int index)` When masking a string, items in this list will be skipped when replacing.
`java.util.List<CharsToIgnore.Builder>`	`getCharactersToIgnoreBuilderList()` 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.
`CharacterMaskConfig`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`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.
`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.
`int`	`getNumberToMask()` Number of characters to mask.
`boolean`	`getReverseOrder()` Mask characters in reverse order.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`CharacterMaskConfig.Builder`	`mergeFrom(CharacterMaskConfig other)`
`CharacterMaskConfig.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`CharacterMaskConfig.Builder`	`mergeFrom(Message other)`
`CharacterMaskConfig.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`CharacterMaskConfig.Builder`	`removeCharactersToIgnore(int index)` When masking a string, items in this list will be skipped when replacing.
`CharacterMaskConfig.Builder`	`setCharactersToIgnore(int index, CharsToIgnore.Builder builderForValue)` When masking a string, items in this list will be skipped when replacing.
`CharacterMaskConfig.Builder`	`setCharactersToIgnore(int index, CharsToIgnore value)` When masking a string, items in this list will be skipped when replacing.
`CharacterMaskConfig.Builder`	`setField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`CharacterMaskConfig.Builder`	`setMaskingCharacter(java.lang.String value)` 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.
`CharacterMaskConfig.Builder`	`setMaskingCharacterBytes(ByteString value)` 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.
`CharacterMaskConfig.Builder`	`setNumberToMask(int value)` Number of characters to mask.
`CharacterMaskConfig.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`CharacterMaskConfig.Builder`	`setReverseOrder(boolean value)` Mask characters in reverse order.
`CharacterMaskConfig.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<CharacterMaskConfig.Builder>

clear
```
public CharacterMaskConfig.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<CharacterMaskConfig.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<CharacterMaskConfig.Builder>

getDefaultInstanceForType
```
public CharacterMaskConfig getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public CharacterMaskConfig build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public CharacterMaskConfig buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public CharacterMaskConfig.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<CharacterMaskConfig.Builder>

setField

public CharacterMaskConfig.Builder setField(Descriptors.FieldDescriptor field,
                                            java.lang.Object value)

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<CharacterMaskConfig.Builder>

clearField
```
public CharacterMaskConfig.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<CharacterMaskConfig.Builder>

clearOneof
```
public CharacterMaskConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<CharacterMaskConfig.Builder>

setRepeatedField

public CharacterMaskConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                                    int index,
                                                    java.lang.Object value)

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<CharacterMaskConfig.Builder>

addRepeatedField

public CharacterMaskConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                                    java.lang.Object value)

Specified by:: addRepeatedField in interface Message.Builder
Overrides:: addRepeatedField in class GeneratedMessageV3.Builder<CharacterMaskConfig.Builder>

mergeFrom
```
public CharacterMaskConfig.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<CharacterMaskConfig.Builder>

mergeFrom

public CharacterMaskConfig.Builder mergeFrom(CharacterMaskConfig other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<CharacterMaskConfig.Builder>

mergeFrom

public CharacterMaskConfig.Builder mergeFrom(CodedInputStream input,
                                             ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class AbstractMessage.Builder<CharacterMaskConfig.Builder>
Throws:: java.io.IOException

getMaskingCharacter

public 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. 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&mdash;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

setMaskingCharacter

public CharacterMaskConfig.Builder setMaskingCharacter(java.lang.String value)

 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. String must have length 1. If not supplied, we
 will default to "*" for strings, 0 for digits.

string masking_character = 1;

clearMaskingCharacter

public CharacterMaskConfig.Builder clearMaskingCharacter()

 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. String must have length 1. If not supplied, we
 will default to "*" for strings, 0 for digits.

string masking_character = 1;

setMaskingCharacterBytes

public CharacterMaskConfig.Builder setMaskingCharacterBytes(ByteString value)

 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. String must have length 1. If not supplied, we
 will default to "*" for strings, 0 for digits.

string masking_character = 1;

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

setNumberToMask

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.

int32 number_to_mask = 2;

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.

int32 number_to_mask = 2;

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

setReverseOrder

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

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