Data Loss Prevention V2 Client - Class ExcludeByImageFindings (2.10.0)

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

The rule to exclude image findings based on spatial relationships with other image findings. For example, exclude an image finding if it overlaps with another image finding.

This rule is silently ignored if the content being inspected is not an image.

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

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ info_types array<InfoType>

A list of image-supported infoTypes—excluding document infoTypes—to be used as context for the exclusion rule. A finding is excluded if its bounding box has the specified spatial relationship (defined by image_containment_type) with a finding of an infoType in this list. For example, if InspectionRuleSet.info_types includes OBJECT_TYPE/PERSON and this exclusion_rule specifies info_types as OBJECT_TYPE/PERSON/PASSPORT with image_containment_type set to encloses, then OBJECT_TYPE/PERSON findings will be excluded if they are fully contained within the bounding box of an OBJECT_TYPE/PERSON/PASSPORT finding.

↳ image_containment_type ImageContainmentType

Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings.

getInfoTypes

A list of image-supported infoTypes—excluding document infoTypes—to be used as context for the exclusion rule. A finding is excluded if its bounding box has the specified spatial relationship (defined by image_containment_type) with a finding of an infoType in this list.

For example, if InspectionRuleSet.info_types includes OBJECT_TYPE/PERSON and this exclusion_rule specifies info_types as OBJECT_TYPE/PERSON/PASSPORT with image_containment_type set to encloses, then OBJECT_TYPE/PERSON findings will be excluded if they are fully contained within the bounding box of an OBJECT_TYPE/PERSON/PASSPORT finding.

Returns
Type Description
Google\Protobuf\RepeatedField<InfoType>

setInfoTypes

A list of image-supported infoTypes—excluding document infoTypes—to be used as context for the exclusion rule. A finding is excluded if its bounding box has the specified spatial relationship (defined by image_containment_type) with a finding of an infoType in this list.

For example, if InspectionRuleSet.info_types includes OBJECT_TYPE/PERSON and this exclusion_rule specifies info_types as OBJECT_TYPE/PERSON/PASSPORT with image_containment_type set to encloses, then OBJECT_TYPE/PERSON findings will be excluded if they are fully contained within the bounding box of an OBJECT_TYPE/PERSON/PASSPORT finding.

Parameter
Name Description
var array<InfoType>
Returns
Type Description
$this

getImageContainmentType

Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings.

Returns
Type Description
ImageContainmentType|null

hasImageContainmentType

clearImageContainmentType

setImageContainmentType

Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings.

Parameter
Name Description
var ImageContainmentType
Returns
Type Description
$this