List

Lists job triggers

5 variables
23 variables

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

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services

Input

This building block consumes 5 input parameters

  = Parameter name
  = Format

parent STRING Required

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

pageToken STRING

Optional page token to continue retrieval. Comes from previous call to ListJobTriggers. order_by field must not change for subsequent calls

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,update_time, create_time desc

Supported fields are:

  • create_time: corresponds to time the JobTrigger was created.
  • update_time: corresponds to time the JobTrigger was last updated.
  • last_run_time: corresponds to the last time the JobTrigger ran.
  • name: corresponds to JobTrigger's name.
  • display_name: corresponds to JobTrigger's display name.
  • status: corresponds to JobTrigger's status.

pageSize INTEGER

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

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
    • 'last_run_time` - 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)
  • last_run_time > "2017-12-12T00:00:00+00:00"

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

Output

This building block provides 23 output parameters

  = Parameter name
  = Format

nextPageToken STRING

If the next page is available then the next page token to be used in following ListJobTriggers request

jobTriggers[] OBJECT

Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more

jobTriggers[].createTime ANY

The creation timestamp of a triggeredJob, output only field

jobTriggers[].status ENUMERATION

A status for this trigger. [required]

jobTriggers[].inspectJob OBJECT

jobTriggers[].inspectJob.inspectConfig OBJECT

Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used

jobTriggers[].inspectJob.inspectConfig.contentOptions[] ENUMERATION

jobTriggers[].inspectJob.inspectConfig.excludeInfoTypes BOOLEAN

When true, excludes type information of the findings

jobTriggers[].inspectJob.inspectConfig.minLikelihood ENUMERATION

Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more

jobTriggers[].inspectJob.inspectConfig.includeQuote BOOLEAN

When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote

jobTriggers[].inspectJob.inspectTemplateName STRING

If provided, will be used as the default for all values in InspectConfig. inspect_config will be merged into the values persisted as part of the template

jobTriggers[].inspectJob.storageConfig OBJECT

Shared message indicating Cloud storage type

jobTriggers[].inspectJob.actions[] OBJECT

A task to execute on the completion of a job. See https://cloud.google.com/dlp/docs/concepts-actions to learn more

jobTriggers[].updateTime ANY

The last update timestamp of a triggeredJob, output only field

jobTriggers[].name STRING

Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example projects/dlp-test-project/triggeredJobs/53234423

jobTriggers[].triggers[] OBJECT

What event needs to occur for a new job to be started

jobTriggers[].triggers[].schedule OBJECT

Schedule for triggeredJobs

jobTriggers[].errors[] OBJECT

Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. Output only field

jobTriggers[].errors[].timestamps[] ANY

jobTriggers[].errors[].details OBJECT

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide

jobTriggers[].lastRunTime ANY

The timestamp of the last time this trigger executed, output only field

jobTriggers[].displayName STRING

Display name (max 100 chars)

jobTriggers[].description STRING

User provided description (max 256 chars)