Data Loss Prevention V2 Client - Class InspectConfig (1.9.0)

Version 1.9.0

• 2.2.1 (latest)
• 2.2.0
• 2.1.0
• 2.0.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.1
• 1.14.0
• 1.13.2
• 1.12.0
• 1.11.0
• 1.10.2
• 1.9.0
• 1.8.6

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

Configuration description of the scanning process.

When used with redactContent only info_types and min_likelihood are currently used.

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

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ info_types	array<Google\Cloud\Dlp\V2\InfoType> Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.
↳ min_likelihood	int Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.
↳ limits	Google\Cloud\Dlp\V2\InspectConfig\FindingLimits Configuration to control the number of findings returned. This is not used for data profiling. When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error.
↳ include_quote	bool When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote. This is not used for data profiling.
↳ exclude_info_types	bool When true, excludes type information of the findings. This is not used for data profiling.
↳ custom_info_types	array<Google\Cloud\Dlp\V2\CustomInfoType> CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.
↳ content_options	array Deprecated and unused.
↳ rule_set	array<Google\Cloud\Dlp\V2\InspectionRuleSet> Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.

getInfoTypes

Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference.

When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setInfoTypes

Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference.

When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.

Parameter
Name	Description
var	array<Google\Cloud\Dlp\V2\InfoType>

Returns
Type	Description
$this

getMinLikelihood

Only returns findings equal or above this threshold. The default is POSSIBLE.

See https://cloud.google.com/dlp/docs/likelihood to learn more.

Returns
Type	Description
int

setMinLikelihood

Only returns findings equal or above this threshold. The default is POSSIBLE.

See https://cloud.google.com/dlp/docs/likelihood to learn more.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getLimits

Configuration to control the number of findings returned.

This is not used for data profiling. When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error.

Returns
Type	Description
Google\Cloud\Dlp\V2\InspectConfig\FindingLimits|null

hasLimits

clearLimits

setLimits

Configuration to control the number of findings returned.

This is not used for data profiling. When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error.

Parameter
Name	Description
var	Google\Cloud\Dlp\V2\InspectConfig\FindingLimits

Returns
Type	Description
$this

getIncludeQuote

When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.

This is not used for data profiling.

Returns
Type	Description
bool

setIncludeQuote

When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.

This is not used for data profiling.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getExcludeInfoTypes

When true, excludes type information of the findings.

This is not used for data profiling.

Returns
Type	Description
bool

setExcludeInfoTypes

When true, excludes type information of the findings.

This is not used for data profiling.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getCustomInfoTypes

CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setCustomInfoTypes

CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

Parameter
Name	Description
var	array<Google\Cloud\Dlp\V2\CustomInfoType>

Returns
Type	Description
$this

getContentOptions

Deprecated and unused.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setContentOptions

Deprecated and unused.

Parameter
Name	Description
var	int[]

Returns
Type	Description
$this

getRuleSet

Set of rules to apply to the findings for this InspectConfig.

Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setRuleSet

Set of rules to apply to the findings for this InspectConfig.

Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.

Parameter
Name	Description
var	array<Google\Cloud\Dlp\V2\InspectionRuleSet>

Returns
Type	Description
$this