Class CustomInfoType.Dictionary (3.48.0)

public static final class CustomInfoType.Dictionary extends GeneratedMessageV3 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 Fields

CLOUD_STORAGE_PATH_FIELD_NUMBER

public static final int CLOUD_STORAGE_PATH_FIELD_NUMBER
Field Value
Type Description
int

WORD_LIST_FIELD_NUMBER

public static final int WORD_LIST_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CustomInfoType.Dictionary getDefaultInstance()
Returns
Type Description
CustomInfoType.Dictionary

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CustomInfoType.Dictionary.Builder newBuilder()
Returns
Type Description
CustomInfoType.Dictionary.Builder

newBuilder(CustomInfoType.Dictionary prototype)

public static CustomInfoType.Dictionary.Builder newBuilder(CustomInfoType.Dictionary prototype)
Parameter
Name Description
prototype CustomInfoType.Dictionary
Returns
Type Description
CustomInfoType.Dictionary.Builder

parseDelimitedFrom(InputStream input)

public static CustomInfoType.Dictionary parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomInfoType.Dictionary
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.Dictionary parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomInfoType.Dictionary
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CustomInfoType.Dictionary parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CustomInfoType.Dictionary
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.Dictionary parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomInfoType.Dictionary
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CustomInfoType.Dictionary parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CustomInfoType.Dictionary
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.Dictionary parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomInfoType.Dictionary
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CustomInfoType.Dictionary parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CustomInfoType.Dictionary
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.Dictionary parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomInfoType.Dictionary
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CustomInfoType.Dictionary parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomInfoType.Dictionary
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.Dictionary parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomInfoType.Dictionary
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CustomInfoType.Dictionary parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CustomInfoType.Dictionary
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.Dictionary parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomInfoType.Dictionary
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CustomInfoType.Dictionary> parser()
Returns
Type Description
Parser<Dictionary>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Type Description
CloudStoragePath

The cloudStoragePath.

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
Type Description
CloudStoragePathOrBuilder

getDefaultInstanceForType()

public CustomInfoType.Dictionary getDefaultInstanceForType()
Returns
Type Description
CustomInfoType.Dictionary

getParserForType()

public Parser<CustomInfoType.Dictionary> getParserForType()
Returns
Type Description
Parser<Dictionary>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceCase()

public CustomInfoType.Dictionary.SourceCase getSourceCase()
Returns
Type Description
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
Type Description
CustomInfoType.Dictionary.WordList

The wordList.

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
Type Description
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
Type Description
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
Type Description
boolean

Whether the wordList field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CustomInfoType.Dictionary.Builder newBuilderForType()
Returns
Type Description
CustomInfoType.Dictionary.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CustomInfoType.Dictionary.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CustomInfoType.Dictionary.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CustomInfoType.Dictionary.Builder toBuilder()
Returns
Type Description
CustomInfoType.Dictionary.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException