Reference documentation and code samples for the Data Loss Prevention V2 Client class HotwordRule.
The rule that adjusts the likelihood of findings within a certain proximity of hotwords.
Generated from protobuf message google.privacy.dlp.v2.CustomInfoType.DetectionRule.HotwordRule
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ hotword_regex |
Google\Cloud\Dlp\V2\CustomInfoType\Regex
Regular expression pattern defining what qualifies as a hotword. |
↳ proximity |
Google\Cloud\Dlp\V2\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. |
↳ likelihood_adjustment |
Google\Cloud\Dlp\V2\CustomInfoType\DetectionRule\LikelihoodAdjustment
Likelihood adjustment to apply to all matching findings. |
getHotwordRegex
Regular expression pattern defining what qualifies as a hotword.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dlp\V2\CustomInfoType\Regex|null | |
hasHotwordRegex
clearHotwordRegex
setHotwordRegex
Regular expression pattern defining what qualifies as a hotword.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dlp\V2\CustomInfoType\Regex
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProximity
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.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dlp\V2\CustomInfoType\DetectionRule\Proximity|null | |
hasProximity
clearProximity
setProximity
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dlp\V2\CustomInfoType\DetectionRule\Proximity
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLikelihoodAdjustment
Likelihood adjustment to apply to all matching findings.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dlp\V2\CustomInfoType\DetectionRule\LikelihoodAdjustment|null | |
hasLikelihoodAdjustment
clearLikelihoodAdjustment
setLikelihoodAdjustment
Likelihood adjustment to apply to all matching findings.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dlp\V2\CustomInfoType\DetectionRule\LikelihoodAdjustment
|
| Returns | |
|---|---|
| Type | Description |
$this | |