Method: projects.locations.listPipelines

Lists pipelines.

Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.

HTTP request

GET https://datapipelines.googleapis.com/v1/{parent=projects/*/locations/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

Query parameters

Parameters
filter

string

An expression for filtering the results of the request. If unspecified, all pipelines will be returned. Multiple filters can be applied and must be comma separated.

Fields eligible for filtering are:

  • type: The type of the pipeline (streaming or batch). Allowed values are ALL, BATCH, and STREAMING.
  • status: The activity status of the pipeline. Allowed values are ALL, ACTIVE, ARCHIVED, and PAUSED.

For example, to limit results to active batch processing pipelines:

type:BATCH,status:ACTIVE
pageSize

integer

The maximum number of entities to return. The service may return fewer than this value, even if there are additional pages. If unspecified, the max limit is yet to be determined by the backend implementation.

pageToken

string

A page token, received from a previous locations.listPipelines call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to locations.listPipelines must match the call that provided the page token.

Request body

The request body must be empty.

Response body

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

Response message for locations.listPipelines.

JSON representation
{
  "pipelines": [
    {
      object (Pipeline)
    }
  ],
  "nextPageToken": string
}
Fields
pipelines[]

object (Pipeline)

Results that matched the filter criteria and were accessible to the caller. Results are always in descending order of pipeline creation date.

nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

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:

  • datapipelines.pipelines.list

For more information, see the IAM documentation.