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 \ V2Methods
__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: |
↳ 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: |
↳ 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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-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 exampleparent
string specifies a parent project with the identifierexample-project
, and specifies theeurope-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
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 | |
---|---|
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 |
static::build
Parameters | |
---|---|
Name | Description |
parent |
string
Required. Parent resource name. The format of this value varies depending on whether you have specified a processing location:
The following example 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 | |
---|---|
Type | Description |
Google\Cloud\Dlp\V2\CreateDlpJobRequest |
static::buildFromParentRiskJob
Parameters | |
---|---|
Name | Description |
parent |
string
Required. Parent resource name. The format of this value varies depending on whether you have specified a processing location:
The following example 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 | |
---|---|
Type | Description |
Google\Cloud\Dlp\V2\CreateDlpJobRequest |