Method: projects.locations.pipelineJobs.batchCancel

Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.

HTTP request

POST https://{service-endpoint}/v1/{parent}/pipelineJobs:batchCancel

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
parent

string

Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "names": [
    string
  ]
}
Fields
names[]

string

Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}

Response body

If successful, the response body contains an instance of 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 parent resource:

  • aiplatform.pipelineJobs.cancel

For more information, see the IAM documentation.