Class CustomInfoType.Dictionary (3.25.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
TypeDescription
int

WORD_LIST_FIELD_NUMBER

public static final int WORD_LIST_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CustomInfoType.Dictionary getDefaultInstance()
Returns
TypeDescription
CustomInfoType.Dictionary

getDescriptor()

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

newBuilder()

public static CustomInfoType.Dictionary.Builder newBuilder()
Returns
TypeDescription
CustomInfoType.Dictionary.Builder

newBuilder(CustomInfoType.Dictionary prototype)

public static CustomInfoType.Dictionary.Builder newBuilder(CustomInfoType.Dictionary prototype)
Parameter
NameDescription
prototypeCustomInfoType.Dictionary
Returns
TypeDescription
CustomInfoType.Dictionary.Builder

parseDelimitedFrom(InputStream input)

public static CustomInfoType.Dictionary parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CustomInfoType.Dictionary
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.Dictionary parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomInfoType.Dictionary
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CustomInfoType.Dictionary parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CustomInfoType.Dictionary
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.Dictionary parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomInfoType.Dictionary
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CustomInfoType.Dictionary parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CustomInfoType.Dictionary
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.Dictionary parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomInfoType.Dictionary
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CustomInfoType.Dictionary parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CustomInfoType.Dictionary
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.Dictionary parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomInfoType.Dictionary
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CustomInfoType.Dictionary parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CustomInfoType.Dictionary
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.Dictionary parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomInfoType.Dictionary
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CustomInfoType.Dictionary parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CustomInfoType.Dictionary
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.Dictionary parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomInfoType.Dictionary
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
CloudStoragePathOrBuilder

getDefaultInstanceForType()

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

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
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.

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CustomInfoType.Dictionary.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CustomInfoType.Dictionary.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException