Method: projects.locations.trainingPipelines.list

Lists TrainingPipelines in a Location.

HTTP request

GET https://{service-endpoint}/v1/{parent}/trainingPipelines

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 TrainingPipelines from. Format: projects/{project}/locations/{location}

Query parameters

Parameters
filter

string

The standard list filter.

Supported fields:

  • displayName supports =, != comparisons, and : wildcard.
  • state supports =, != comparisons.
  • trainingTaskDefinition =, != comparisons, and : wildcard.
  • createTime supports =, !=,<, <=,>, >= comparisons. createTime must be in RFC 3339 format.
  • labels supports general map functions that is: labels.key=value - key:value equality `labels.key:* - key existence

Some examples of using the filter are:

  • state="PIPELINE_STATE_SUCCEEDED" AND displayName:"my_pipeline_*"
  • state!="PIPELINE_STATE_FAILED" OR displayName="my_pipeline"
  • NOT displayName="my_pipeline"
  • createTime>"2021-05-18T00:00:00Z"
  • trainingTaskDefinition:"*automlTextClassification*"
pageSize

integer

The standard list page size.
pageToken

string

The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.
readMask

string (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 for PipelineService.ListTrainingPipelines

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

JSON representation 
{
  "trainingPipelines": [
    {
      object (TrainingPipeline)
    }
  ],
  "nextPageToken": string
}
Fields
trainingPipelines[]

object (TrainingPipeline)

List of TrainingPipelines in the requested page.
nextPageToken

string

A token to retrieve the next page of results. Pass to ListTrainingPipelinesRequest.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.trainingPipelines.list

For more information, see the IAM documentation.