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
Namespace
Google \ Cloud \ Dlp \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The server-assigned name. |
↳ type |
int
The type of job. |
↳ state |
int
Output only. State of a job. |
↳ risk_details |
AnalyzeDataSourceRiskDetails
Results from analyzing risk of a data source. |
↳ inspect_details |
InspectDataSourceDetails
Results from inspecting a data source. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time when the job was created. |
↳ start_time |
Google\Protobuf\Timestamp
Output only. Time when the job started. |
↳ end_time |
Google\Protobuf\Timestamp
Output only. Time when the job finished. |
↳ last_modified |
Google\Protobuf\Timestamp
Output only. Time when the job was last modified by the system. |
↳ job_trigger_name |
string
Output only. If created by a job trigger, the resource name of the trigger that instantiated the job. |
↳ errors |
array<Error>
Output only. A stream of errors encountered running the job. |
↳ action_details |
array<ActionDetails>
Output only. Events that should occur after the job has completed. |
getName
Output only. The server-assigned name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. The server-assigned name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
The type of job.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type DlpJobType. |
setType
The type of job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type DlpJobType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. State of a job.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type JobState. |
setState
Output only. State of a job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type JobState. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRiskDetails
Results from analyzing risk of a data source.
| Returns | |
|---|---|
| Type | Description |
AnalyzeDataSourceRiskDetails|null |
|
hasRiskDetails
setRiskDetails
Results from analyzing risk of a data source.
| Parameter | |
|---|---|
| Name | Description |
var |
AnalyzeDataSourceRiskDetails
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInspectDetails
Results from inspecting a data source.
| Returns | |
|---|---|
| Type | Description |
InspectDataSourceDetails|null |
|
hasInspectDetails
setInspectDetails
Results from inspecting a data source.
| Parameter | |
|---|---|
| Name | Description |
var |
InspectDataSourceDetails
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Time when the job was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when the job was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartTime
Output only. Time when the job started.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStartTime
clearStartTime
setStartTime
Output only. Time when the job started.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTime
Output only. Time when the job finished.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEndTime
clearEndTime
setEndTime
Output only. Time when the job finished.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLastModified
Output only. Time when the job was last modified by the system.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasLastModified
clearLastModified
setLastModified
Output only. Time when the job was last modified by the system.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getJobTriggerName
Output only. If created by a job trigger, the resource name of the trigger that instantiated the job.
| Returns | |
|---|---|
| Type | Description |
string |
|
setJobTriggerName
Output only. 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
Output only. A stream of errors encountered running the job.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Error> |
|
setErrors
Output only. A stream of errors encountered running the job.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Error>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getActionDetails
Output only. Events that should occur after the job has completed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ActionDetails> |
|
setActionDetails
Output only. Events that should occur after the job has completed.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ActionDetails>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDetails
| Returns | |
|---|---|
| Type | Description |
string |
|