Class CustomInfoType.Dictionary.Builder (3.38.0)

public static final class CustomInfoType.Dictionary.Builder extends GeneratedMessageV3.Builder<CustomInfoType.Dictionary.Builder> implements CustomInfoType.DictionaryOrBuilder

Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles.

Dictionary words are case-insensitive and all characters other than letters and digits in the unicode Basic Multilingual Plane will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer".

Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The limits page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using LargeCustomDictionaryConfig in the StoredInfoType API.

Protobuf type google.privacy.dlp.v2.CustomInfoType.Dictionary

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CustomInfoType.Dictionary.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CustomInfoType.Dictionary.Builder
Overrides

build()

public CustomInfoType.Dictionary build()
Returns
TypeDescription
CustomInfoType.Dictionary

buildPartial()

public CustomInfoType.Dictionary buildPartial()
Returns
TypeDescription
CustomInfoType.Dictionary

clear()

public CustomInfoType.Dictionary.Builder clear()
Returns
TypeDescription
CustomInfoType.Dictionary.Builder
Overrides

clearCloudStoragePath()

public CustomInfoType.Dictionary.Builder clearCloudStoragePath()

Newline-delimited file of words in Cloud Storage. Only a single file is accepted.

.google.privacy.dlp.v2.CloudStoragePath cloud_storage_path = 3;

Returns
TypeDescription
CustomInfoType.Dictionary.Builder

clearField(Descriptors.FieldDescriptor field)

public CustomInfoType.Dictionary.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CustomInfoType.Dictionary.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CustomInfoType.Dictionary.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
CustomInfoType.Dictionary.Builder
Overrides

clearSource()

public CustomInfoType.Dictionary.Builder clearSource()
Returns
TypeDescription
CustomInfoType.Dictionary.Builder

clearWordList()

public CustomInfoType.Dictionary.Builder clearWordList()

List of words or phrases to search for.

.google.privacy.dlp.v2.CustomInfoType.Dictionary.WordList word_list = 1;

Returns
TypeDescription
CustomInfoType.Dictionary.Builder

clone()

public CustomInfoType.Dictionary.Builder clone()
Returns
TypeDescription
CustomInfoType.Dictionary.Builder
Overrides

getCloudStoragePath()

public CloudStoragePath getCloudStoragePath()

Newline-delimited file of words in Cloud Storage. Only a single file is accepted.

.google.privacy.dlp.v2.CloudStoragePath cloud_storage_path = 3;

Returns
TypeDescription
CloudStoragePath

The cloudStoragePath.

getCloudStoragePathBuilder()

public CloudStoragePath.Builder getCloudStoragePathBuilder()

Newline-delimited file of words in Cloud Storage. Only a single file is accepted.

.google.privacy.dlp.v2.CloudStoragePath cloud_storage_path = 3;

Returns
TypeDescription
CloudStoragePath.Builder

getCloudStoragePathOrBuilder()

public CloudStoragePathOrBuilder getCloudStoragePathOrBuilder()

Newline-delimited file of words in Cloud Storage. Only a single file is accepted.

.google.privacy.dlp.v2.CloudStoragePath cloud_storage_path = 3;

Returns
TypeDescription
CloudStoragePathOrBuilder

getDefaultInstanceForType()

public CustomInfoType.Dictionary getDefaultInstanceForType()
Returns
TypeDescription
CustomInfoType.Dictionary

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getSourceCase()

public CustomInfoType.Dictionary.SourceCase getSourceCase()
Returns
TypeDescription
CustomInfoType.Dictionary.SourceCase

getWordList()

public CustomInfoType.Dictionary.WordList getWordList()

List of words or phrases to search for.

.google.privacy.dlp.v2.CustomInfoType.Dictionary.WordList word_list = 1;

Returns
TypeDescription
CustomInfoType.Dictionary.WordList

The wordList.

getWordListBuilder()

public CustomInfoType.Dictionary.WordList.Builder getWordListBuilder()

List of words or phrases to search for.

.google.privacy.dlp.v2.CustomInfoType.Dictionary.WordList word_list = 1;

Returns
TypeDescription
CustomInfoType.Dictionary.WordList.Builder

getWordListOrBuilder()

public CustomInfoType.Dictionary.WordListOrBuilder getWordListOrBuilder()

List of words or phrases to search for.

.google.privacy.dlp.v2.CustomInfoType.Dictionary.WordList word_list = 1;

Returns
TypeDescription
CustomInfoType.Dictionary.WordListOrBuilder

hasCloudStoragePath()

public boolean hasCloudStoragePath()

Newline-delimited file of words in Cloud Storage. Only a single file is accepted.

.google.privacy.dlp.v2.CloudStoragePath cloud_storage_path = 3;

Returns
TypeDescription
boolean

Whether the cloudStoragePath field is set.

hasWordList()

public boolean hasWordList()

List of words or phrases to search for.

.google.privacy.dlp.v2.CustomInfoType.Dictionary.WordList word_list = 1;

Returns
TypeDescription
boolean

Whether the wordList field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCloudStoragePath(CloudStoragePath value)

public CustomInfoType.Dictionary.Builder mergeCloudStoragePath(CloudStoragePath value)

Newline-delimited file of words in Cloud Storage. Only a single file is accepted.

.google.privacy.dlp.v2.CloudStoragePath cloud_storage_path = 3;

Parameter
NameDescription
valueCloudStoragePath
Returns
TypeDescription
CustomInfoType.Dictionary.Builder

mergeFrom(CustomInfoType.Dictionary other)

public CustomInfoType.Dictionary.Builder mergeFrom(CustomInfoType.Dictionary other)
Parameter
NameDescription
otherCustomInfoType.Dictionary
Returns
TypeDescription
CustomInfoType.Dictionary.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CustomInfoType.Dictionary.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomInfoType.Dictionary.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CustomInfoType.Dictionary.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CustomInfoType.Dictionary.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CustomInfoType.Dictionary.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CustomInfoType.Dictionary.Builder
Overrides

mergeWordList(CustomInfoType.Dictionary.WordList value)

public CustomInfoType.Dictionary.Builder mergeWordList(CustomInfoType.Dictionary.WordList value)

List of words or phrases to search for.

.google.privacy.dlp.v2.CustomInfoType.Dictionary.WordList word_list = 1;

Parameter
NameDescription
valueCustomInfoType.Dictionary.WordList
Returns
TypeDescription
CustomInfoType.Dictionary.Builder

setCloudStoragePath(CloudStoragePath value)

public CustomInfoType.Dictionary.Builder setCloudStoragePath(CloudStoragePath value)

Newline-delimited file of words in Cloud Storage. Only a single file is accepted.

.google.privacy.dlp.v2.CloudStoragePath cloud_storage_path = 3;

Parameter
NameDescription
valueCloudStoragePath
Returns
TypeDescription
CustomInfoType.Dictionary.Builder

setCloudStoragePath(CloudStoragePath.Builder builderForValue)

public CustomInfoType.Dictionary.Builder setCloudStoragePath(CloudStoragePath.Builder builderForValue)

Newline-delimited file of words in Cloud Storage. Only a single file is accepted.

.google.privacy.dlp.v2.CloudStoragePath cloud_storage_path = 3;

Parameter
NameDescription
builderForValueCloudStoragePath.Builder
Returns
TypeDescription
CustomInfoType.Dictionary.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CustomInfoType.Dictionary.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CustomInfoType.Dictionary.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CustomInfoType.Dictionary.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CustomInfoType.Dictionary.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CustomInfoType.Dictionary.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CustomInfoType.Dictionary.Builder
Overrides

setWordList(CustomInfoType.Dictionary.WordList value)

public CustomInfoType.Dictionary.Builder setWordList(CustomInfoType.Dictionary.WordList value)

List of words or phrases to search for.

.google.privacy.dlp.v2.CustomInfoType.Dictionary.WordList word_list = 1;

Parameter
NameDescription
valueCustomInfoType.Dictionary.WordList
Returns
TypeDescription
CustomInfoType.Dictionary.Builder

setWordList(CustomInfoType.Dictionary.WordList.Builder builderForValue)

public CustomInfoType.Dictionary.Builder setWordList(CustomInfoType.Dictionary.WordList.Builder builderForValue)

List of words or phrases to search for.

.google.privacy.dlp.v2.CustomInfoType.Dictionary.WordList word_list = 1;

Parameter
NameDescription
builderForValueCustomInfoType.Dictionary.WordList.Builder
Returns
TypeDescription
CustomInfoType.Dictionary.Builder