Data Loss Prevention V2 Client - Class Dictionary (1.19.0)

Reference documentation and code samples for the Data Loss Prevention V2 Client class Dictionary.

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.

Generated from protobuf message google.privacy.dlp.v2.CustomInfoType.Dictionary

Namespace

Google \ Cloud \ Dlp \ V2 \ CustomInfoType

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ word_list`	`Google\Cloud\Dlp\V2\CustomInfoType\Dictionary\WordList` List of words or phrases to search for.
`↳ cloud_storage_path`	`Google\Cloud\Dlp\V2\CloudStoragePath` Newline-delimited file of words in Cloud Storage. Only a single file is accepted.

getWordList

List of words or phrases to search for.

Returns
Type	Description
`Google\Cloud\Dlp\V2\CustomInfoType\Dictionary\WordList\|null`

hasWordList

setWordList

List of words or phrases to search for.

Parameter
Name	Description
`var`	`Google\Cloud\Dlp\V2\CustomInfoType\Dictionary\WordList`

Returns
Type	Description
`$this`

getCloudStoragePath

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

Returns
Type	Description
`Google\Cloud\Dlp\V2\CloudStoragePath\|null`

hasCloudStoragePath

setCloudStoragePath

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

Parameter
Name	Description
`var`	`Google\Cloud\Dlp\V2\CloudStoragePath`

Returns
Type	Description
`$this`

getSource

Returns
Type	Description
`string`