Data Loss Prevention V2 Client - Class CreateDlpJobRequest (1.9.0)

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

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getInspectJob

An inspection job scans a storage repository for InfoTypes.

Returns
TypeDescription
Google\Cloud\Dlp\V2\InspectJobConfig|null

hasInspectJob

setInspectJob

An inspection job scans a storage repository for InfoTypes.

Parameter
NameDescription
var Google\Cloud\Dlp\V2\InspectJobConfig
Returns
TypeDescription
$this

getRiskJob

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

Returns
TypeDescription
Google\Cloud\Dlp\V2\RiskAnalysisJobConfig|null

hasRiskJob

setRiskJob

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

Parameter
NameDescription
var Google\Cloud\Dlp\V2\RiskAnalysisJobConfig
Returns
TypeDescription
$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
TypeDescription
string

setJobId

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLocationId

Deprecated. This field has no effect.

Returns
TypeDescription
string

setLocationId

Deprecated. This field has no effect.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getJob

Returns
TypeDescription
string

static::build

Parameters
NameDescription
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 Please see Google\Cloud\Dlp\V2\DlpServiceClient::projectName() for help formatting this field.

inspectJob Google\Cloud\Dlp\V2\InspectJobConfig

An inspection job scans a storage repository for InfoTypes.

Returns
TypeDescription
Google\Cloud\Dlp\V2\CreateDlpJobRequest

static::buildFromParentRiskJob

Parameters
NameDescription
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 Please see Google\Cloud\Dlp\V2\DlpServiceClient::projectName() for help formatting this field.

riskJob Google\Cloud\Dlp\V2\RiskAnalysisJobConfig

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

Returns
TypeDescription
Google\Cloud\Dlp\V2\CreateDlpJobRequest