Data Loss Prevention V2 Client - Class CreateDlpJobRequest (1.8.6)

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

Request message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage.

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

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. 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
`↳ inspect_job`	`Google\Cloud\Dlp\V2\InspectJobConfig` An inspection job scans a storage repository for InfoTypes.
`↳ risk_job`	`Google\Cloud\Dlp\V2\RiskAnalysisJobConfig` A risk analysis job calculates re-identification risk metrics for a BigQuery table.
`↳ job_id`	`string` The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.
`↳ location_id`	`string` Deprecated. This field has no effect.

getParent

Required. 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

Required. 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`

getInspectJob

An inspection job scans a storage repository for InfoTypes.

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

hasInspectJob

setInspectJob

An inspection job scans a storage repository for InfoTypes.

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

Returns
Type	Description
`$this`

getRiskJob

A risk analysis job calculates re-identification risk metrics for a BigQuery table.

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

hasRiskJob

setRiskJob

A risk analysis job calculates re-identification risk metrics for a BigQuery table.

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

Returns
Type	Description
`$this`

getJobId

The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

Returns
Type	Description
`string`

setJobId

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`

getJob

Returns
Type	Description
`string`