Reference documentation and code samples for the Data Loss Prevention V2 Client class DlpJob.
Combines all of the information about a DLP job.
Generated from protobuf message google.privacy.dlp.v2.DlpJob
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The server-assigned name. |
↳ type |
int
The type of job. |
↳ state |
int
State of a job. |
↳ risk_details |
Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails
Results from analyzing risk of a data source. |
↳ inspect_details |
Google\Cloud\Dlp\V2\InspectDataSourceDetails
Results from inspecting a data source. |
↳ create_time |
Google\Protobuf\Timestamp
Time when the job was created. |
↳ start_time |
Google\Protobuf\Timestamp
Time when the job started. |
↳ end_time |
Google\Protobuf\Timestamp
Time when the job finished. |
↳ job_trigger_name |
string
If created by a job trigger, the resource name of the trigger that instantiated the job. |
↳ errors |
array<Google\Cloud\Dlp\V2\Error>
A stream of errors encountered running the job. |
getName
The server-assigned name.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The server-assigned name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
The type of job.
| Returns | |
|---|---|
| Type | Description |
int | |
setType
The type of job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
State of a job.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
State of a job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRiskDetails
Results from analyzing risk of a data source.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails|null | |
hasRiskDetails
setRiskDetails
Results from analyzing risk of a data source.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dlp\V2\AnalyzeDataSourceRiskDetails
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInspectDetails
Results from inspecting a data source.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dlp\V2\InspectDataSourceDetails|null | |
hasInspectDetails
setInspectDetails
Results from inspecting a data source.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dlp\V2\InspectDataSourceDetails
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Time when the job was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Time when the job was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStartTime
Time when the job started.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasStartTime
clearStartTime
setStartTime
Time when the job started.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndTime
Time when the job finished.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasEndTime
clearEndTime
setEndTime
Time when the job finished.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getJobTriggerName
If created by a job trigger, the resource name of the trigger that instantiated the job.
| Returns | |
|---|---|
| Type | Description |
string | |
setJobTriggerName
If created by a job trigger, the resource name of the trigger that instantiated the job.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getErrors
A stream of errors encountered running the job.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setErrors
A stream of errors encountered running the job.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dlp\V2\Error>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDetails
| Returns | |
|---|---|
| Type | Description |
string | |