REST Resource: projects.locations.dlpJobs

Resource: DlpJob

Combines all of the information about a DLP job.

JSON representation
{
  "name": string,
  "type": enum (DlpJobType),
  "state": enum (JobState),
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "jobTriggerName": string,
  "errors": [
    {
      object (Error)
    }
  ],

  // Union field details can be only one of the following:
  "riskDetails": {
    object (AnalyzeDataSourceRiskDetails)
  },
  "inspectDetails": {
    object (InspectDataSourceDetails)
  }
  // End of list of possible types for union field details.
}
Fields
name

string

The server-assigned name.

type

enum (DlpJobType)

The type of job.

state

enum (JobState)

State of a job.

createTime

string (Timestamp format)

Time when the job was created.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

startTime

string (Timestamp format)

Time when the job started.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Time when the job finished.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

jobTriggerName

string

If created by a job trigger, the resource name of the trigger that instantiated the job.

errors[]

object (Error)

A stream of errors encountered running the job.

Union field details.

details can be only one of the following:

riskDetails

object (AnalyzeDataSourceRiskDetails)

Results from analyzing risk of a data source.

inspectDetails

object (InspectDataSourceDetails)

Results from inspecting a data source.

Methods

cancel

Starts asynchronous cancellation on a long-running DlpJob.

create

Creates a new job to inspect storage or calculate risk metrics.

delete

Deletes a long-running DlpJob.

get

Gets the latest state of a long-running DlpJob.

list

Lists DlpJobs that match the specified filter in the request.
Was this page helpful? Let us know how we did:

Send feedback about...

Data Loss Prevention Documentation