Method: projects.dlpJobs.list

Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

HTTP request


The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
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/{projectId}/locations/{locationId}
  • Projects scope, no location specified (defaults to global): projects/{projectId}

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

Authorization requires the following IAM permission on the specified resource parent:

  • dlp.jobs.list

Query parameters

Parameters
filter

string

Allows filtering.

Supported syntax:

  • Filter expressions are made up of one or more restrictions.
  • Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
  • A restriction has the form of {field} {operator} {value}.
  • Supported fields/values for inspect jobs:
    • state - PENDING|RUNNING|CANCELED|FINISHED|FAILED
    • inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY
    • triggerName - The name of the trigger that created the job.
    • 'endTime` - Corresponds to the time the job finished.
    • 'startTime` - Corresponds to the time the job finished.
  • Supported fields for risk analysis jobs:
    • state - RUNNING|CANCELED|FINISHED|FAILED
    • 'endTime` - Corresponds to the time the job finished.
    • 'startTime` - Corresponds to the time the job finished.
  • The operator must be = or !=.

Examples:

  • inspected_storage = cloud_storage AND state = done
  • inspected_storage = cloud_storage OR inspected_storage = bigquery
  • inspected_storage = cloud_storage AND (state = done OR state = canceled)
  • endTime > "2017-12-12T00:00:00+00:00"

The length of this field should be no more than 500 characters.
pageSize

integer

The standard list page size.
pageToken

string

The standard list page token.
type

enum (DlpJobType)

The type of job. Defaults to DlpJobType.INSPECT
orderBy

string

Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant.

Example: name asc, endTime asc, createTime desc

Supported fields are:

  • createTime: corresponds to the time the job was created.
  • endTime: corresponds to the time the job ended.
  • name: corresponds to the job's name.
  • state: corresponds to state
locationId

string

Deprecated. This field has no effect.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListDlpJobsResponse.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.