Method: projects.locations.pipelineJobs.list

Lists PipelineJobs in a Location.

HTTP request

GET https://{service-endpoint}/v1beta1/{parent}/pipelineJobs

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
parent

string

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

Query parameters

Parameters
filter

string

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

  • pipeline_name: Supports = and != comparisons.
  • displayName: Supports =, != comparisons, and : wildcard.
  • pipeline_job_user_id: Supports =, != comparisons, and : wildcard. for example, can check if pipeline's displayName contains step 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.

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

The syntax to define filter expression is based on https://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".
pageSize

integer

The standard list page size.

pageToken

string

The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.

orderBy

string

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

Request body

The request body must be empty.

Response body

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

Response message for PipelineService.ListPipelineJobs

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

object (PipelineJob)

List of PipelineJobs in the requested page.

nextPageToken

string

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.pipelineJobs.list

For more information, see the IAM documentation.