Method: pipelineJobs.list

Full name: projects.locations.pipelineJobs.list

Lists PipelineJobs in a Location.

Endpoint

gethttps://{service-endpoint}/v1/{parent}/pipelineJobs

Where{service-endpoint} is one of thesupported service endpoints.

Path parameters

parentstring

Required. The resource name of the Location to list the PipelineJobs from. Format:projects/{project}/locations/{location}

Query parameters

filterstring

Lists the PipelineJobs that match the filter expression. The following fields are supported:

  • pipelineName: Supports= and!= comparisons.
  • displayName: Supports=,!= comparisons, and: wildcard.
  • pipelineJobUserId: Supports=,!= comparisons, and: wildcard. for example, can check if pipeline's displayName containsstep by doing displayName:"*step*"
  • state: Supports= and!= comparisons.
  • createTime: Supports=,!=,<,>,<=, and>= comparisons. Values must be in RFC 3339 format.
  • updateTime: Supports=,!=,<,>,<=, and>= comparisons. Values must be in RFC 3339 format.
  • endTime: Supports=,!=,<,>,<=, and>= comparisons. Values must be in RFC 3339 format.
  • labels: Supports key-value equality and key presence.
  • templateUri: Supports=,!= comparisons, and: wildcard.
  • templateMetadata.version: Supports=,!= comparisons, and: wildcard.

Filter expressions can be combined together using logical operators (AND &OR). For example:pipelineName="test" AND createTime>"2020-05-18T13:30:00Z".

The syntax to define filter expression is based onhttps://google.aip.dev/160.

Examples:

  • createTime>"2021-05-18T00:00:00Z" OR updateTime>"2020-05-18T00:00:00Z" PipelineJobs created or updated after 2020-05-18 00:00:00 UTC.
  • labels.env = "prod" PipelineJobs with label "env" set to "prod".
pageSizeinteger

The standard list page size.

pageTokenstring

The standard list page token. Typically obtained viaListPipelineJobsResponse.next_page_token of the previousPipelineService.ListPipelineJobs call.

orderBystring

A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple orderBy fields provided e.g. "createTime desc, endTime", "endTime, startTime, updateTime" For example, using "createTime desc, endTime" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if orderBy is not specified, it will order by default order is create time in descending order. Supported fields:

  • createTime
  • updateTime
  • endTime
  • startTime
readMaskstring (FieldMask format)

Mask specifying which fields to read.

This is a comma-separated list of fully qualified names of fields. Example:"user.displayName,photo".

Request body

The request body must be empty.

Response body

Response message forPipelineService.ListPipelineJobs

If successful, the response body contains data with the following structure:

Fields
pipelineJobs[]object (PipelineJob)

List of PipelineJobs in the requested page.

nextPageTokenstring

A token to retrieve the next page of results. Pass toListPipelineJobsRequest.page_token to obtain that page.

JSON representation
{"pipelineJobs":[{object (PipelineJob)}],"nextPageToken":string}

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-06-27 UTC.