Method: projects.locations.pipelines.run

Creates a job for the specified pipeline directly. You can use this method when the internal scheduler is not configured and you want to trigger the job directly or through an external system.

Returns a "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FORBIDDEN" error if the user doesn't have permission to access the pipeline or run jobs for the pipeline.

HTTP request

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

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 data with the following structure:

Response message for pipelines.run

JSON representation 
{
  "job": {
    object (Job)
  }
}
Fields
job

object (Job)

Job that was created as part of pipelines.run operation.

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

For more information, see the IAM documentation.