Method: projects.locations.pipelines.get

Stay organized with collections Save and categorize content based on your preferences.

Looks up a single pipeline.

Returns a "NOT_FOUND" error if no such pipeline exists. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The pipeline name. For example: projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Pipeline.

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 name resource:

  • datapipelines.pipelines.get

For more information, see the IAM documentation.