Reference documentation and code samples for the Data Loss Prevention V2 Client class ExcludeByHotword.
The rule to exclude findings based on a hotword. For record inspection of tables, column names are considered hotwords. An example of this is to exclude a finding if a BigQuery column matches a specific pattern.
Generated from protobuf message google.privacy.dlp.v2.ExcludeByHotword
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 windowBefore property in proximity should be set to 1 if the hotword needs to be included in a column header. |
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 windowBefore property in proximity should be set to 1 if the hotword needs to be included in a column header.
| 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 windowBefore property in proximity should be set to 1 if the hotword needs to be included in a column header.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dlp\V2\CustomInfoType\DetectionRule\Proximity
|
| Returns | |
|---|---|
| Type | Description |
$this | |