Data Loss Prevention V2 Client - Class DataProfileJobConfig (1.12.0)

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

Configuration for setting up a job to scan resources for profile generation.

Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the data retention policy.

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

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ location`	`Google\Cloud\Dlp\V2\DataProfileLocation` The data to scan.
`↳ project_id`	`string` The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled.
`↳ inspect_templates`	`array` Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/dlp/docs/data-profiles#data-residency.
`↳ data_profile_actions`	`array<Google\Cloud\Dlp\V2\DataProfileAction>` Actions to execute at the completion of the job.

getLocation

The data to scan.

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

hasLocation

clearLocation

setLocation

The data to scan.

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

Returns
Type	Description
`$this`

getProjectId

The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled.

Returns
Type	Description
`string`

setProjectId

The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getInspectTemplates

Detection logic for profile generation.

Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/dlp/docs/data-profiles#data-residency.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setInspectTemplates

Detection logic for profile generation.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getDataProfileActions

Actions to execute at the completion of the job.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDataProfileActions

Actions to execute at the completion of the job.

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

Returns
Type	Description
`$this`