Method: projects.locations.pipelines.patch

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

Updates a pipeline.

If successful, the updated Pipeline is returned. Returns NOT_FOUND if the pipeline doesn't exist.

If pipelines.patch does not return successfully, you can retry the pipelines.patch request until you receive a successful response.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
pipeline.name

string

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

  • PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see Identifying projects.
  • LOCATION_ID is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling google.cloud.location.Locations.ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in App Engine regions.
  • PIPELINE_ID is the ID of the pipeline. Must be unique for the selected project and location.

Query parameters

Parameters
updateMask

string (FieldMask format)

The list of fields to be updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Pipeline.

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

For more information, see the IAM documentation.