Data Loss Prevention V2 Client - Class RedactImageRequest (1.12.0)

Version 1.12.0

• 1.15.1 (latest)
• 1.15.0
• 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 RedactImageRequest.

Request to search for potentially sensitive info in an image and redact it by covering it with a colored rectangle.

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

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Parent resource name. The format of this value varies depending on whether you have specified a processing location: + Projects scope, location specified: projects/PROJECT_ID/locations/LOCATION_ID + Projects scope, no location specified (defaults to global): projects/PROJECT_ID The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data: parent=projects/example-project/locations/europe-west3
↳ location_id	string Deprecated. This field has no effect.
↳ inspect_config	Google\Cloud\Dlp\V2\InspectConfig Configuration for the inspector.
↳ image_redaction_configs	array<Google\Cloud\Dlp\V2\RedactImageRequest\ImageRedactionConfig> The configuration for specifying what content to redact from images.
↳ include_findings	bool Whether the response should include findings along with the redacted image.
↳ byte_item	Google\Cloud\Dlp\V2\ByteContentItem The content must be PNG, JPEG, SVG or BMP.

getParent

Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

• Projects scope, location specified:
  projects/PROJECT_ID/locations/LOCATION_ID
• Projects scope, no location specified (defaults to global):
  projects/PROJECT_ID The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data: parent=projects/example-project/locations/europe-west3

Returns
Type	Description
string

setParent

Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

• Projects scope, location specified:
  projects/PROJECT_ID/locations/LOCATION_ID
• Projects scope, no location specified (defaults to global):
  projects/PROJECT_ID The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data: parent=projects/example-project/locations/europe-west3

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLocationId

Deprecated. This field has no effect.

Returns
Type	Description
string

setLocationId

Deprecated. This field has no effect.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getInspectConfig

Configuration for the inspector.

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

hasInspectConfig

clearInspectConfig

setInspectConfig

Configuration for the inspector.

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

Returns
Type	Description
$this

getImageRedactionConfigs

The configuration for specifying what content to redact from images.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setImageRedactionConfigs

The configuration for specifying what content to redact from images.

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

Returns
Type	Description
$this

getIncludeFindings

Whether the response should include findings along with the redacted image.

Returns
Type	Description
bool

setIncludeFindings

Whether the response should include findings along with the redacted image.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getByteItem

The content must be PNG, JPEG, SVG or BMP.

Returns
Type	Description
Google\Cloud\Dlp\V2\ByteContentItem|null

hasByteItem

clearByteItem

setByteItem

The content must be PNG, JPEG, SVG or BMP.

Parameter
Name	Description
var	Google\Cloud\Dlp\V2\ByteContentItem

Returns
Type	Description
$this