Class HotwordRule (3.11.1)

HotwordRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The rule that adjusts the likelihood of findings within a certain proximity of hotwords.

Attributes

NameDescription
hotword_regex google.cloud.dlp_v2.types.CustomInfoType.Regex
Regular expression pattern defining what qualifies as a hotword.
proximity google.cloud.dlp_v2.types.CustomInfoType.DetectionRule.Proximity
Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "(\d{3}) \\d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "(xxx)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values).
likelihood_adjustment google.cloud.dlp_v2.types.CustomInfoType.DetectionRule.LikelihoodAdjustment
Likelihood adjustment to apply to all matching findings.