Method: projects.jobTriggers.list

Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

HTTP request

GET https://dlp.googleapis.com/v2/{parent=projects/*}/jobTriggers

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource name, for example projects/my-project-id.

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

  • dlp.jobTriggers.list

Query parameters

Parameters
pageToken

string

Optional page token to continue retrieval. Comes from previous call to jobTriggers.list. orderBy field must not change for subsequent calls.

pageSize

number

Optional size of the page, can be limited by a server.

orderBy

string

Optional comma separated list of triggeredJob fields to order by, followed by asc or desc postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant.

Example: name asc,updateTime, createTime desc

Supported fields are:

  • createTime: corresponds to time the JobTrigger was created.
  • updateTime: corresponds to time the JobTrigger was last updated.
  • lastRunTime: corresponds to the last time the JobTrigger ran.
  • name: corresponds to JobTrigger's name.
  • displayName: corresponds to JobTrigger's display name.
  • status: corresponds to JobTrigger's status.
filter

string

Optional. 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:
    • status - HEALTHY|PAUSED|CANCELLED
    • inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY
    • 'lastRunTime` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored.
    • 'error_count' - Number of errors that have occurred while running.
  • The operator must be = or != for status and inspected_storage.

Examples:

  • inspected_storage = cloud_storage AND status = HEALTHY
  • inspected_storage = cloud_storage OR inspected_storage = bigquery
  • inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY)
  • lastRunTime > "2017-12-12T00:00:00+00:00"

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

string

The geographic location where job triggers will be retrieved from. Use - for all locations. Reserved for future extensions.

Request body

The request body must be empty.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

Try it!