Join the Apache Beam community on July 18th-20th for the Beam Summit 2022 to learn more about Beam and share your expertise.

Method: projects.locations.pipelines.stop

Freezes pipeline execution permanently.

If there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to "ARCHIVED". However, pipeline metadata is retained.

HTTP request

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

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.stop

For more information, see the IAM documentation.