Data Loss Prevention V2 Client - Class ExclusionRule (2.1.0)

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

The rule that specifies conditions when findings of infoTypes specified in InspectionRuleSet are removed from results.

Generated from protobuf message google.privacy.dlp.v2.ExclusionRule

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ dictionary`	`Google\Cloud\Dlp\V2\CustomInfoType\Dictionary` Dictionary which defines the rule.
`↳ regex`	`Google\Cloud\Dlp\V2\CustomInfoType\Regex` Regular expression which defines the rule.
`↳ exclude_info_types`	`Google\Cloud\Dlp\V2\ExcludeInfoTypes` Set of infoTypes for which findings would affect this rule.
`↳ exclude_by_hotword`	`Google\Cloud\Dlp\V2\ExcludeByHotword` Drop if the hotword rule is contained in the proximate context. For tabular data, the context includes the column name.
`↳ matching_type`	`int` How the rule is applied, see MatchingType documentation for details.

getDictionary

Dictionary which defines the rule.

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

hasDictionary

setDictionary

Dictionary which defines the rule.

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

Returns
Type	Description
`$this`

getRegex

Regular expression which defines the rule.

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

hasRegex

setRegex

Regular expression which defines the rule.

Parameter
Name	Description
`var`	`Google\Cloud\Dlp\V2\CustomInfoType\Regex`

Returns
Type	Description
`$this`

getExcludeInfoTypes

Set of infoTypes for which findings would affect this rule.

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

hasExcludeInfoTypes

setExcludeInfoTypes

Set of infoTypes for which findings would affect this rule.

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

Returns
Type	Description
`$this`

getExcludeByHotword

Drop if the hotword rule is contained in the proximate context. For tabular data, the context includes the column name.

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

hasExcludeByHotword

setExcludeByHotword

Drop if the hotword rule is contained in the proximate context. For tabular data, the context includes the column name.

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

Returns
Type	Description
`$this`

getMatchingType

How the rule is applied, see MatchingType documentation for details.

Returns
Type	Description
`int`

setMatchingType

How the rule is applied, see MatchingType documentation for details.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getType

Returns
Type	Description
`string`