Method: googleapis.aiplatform.v1beta1.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.

This method waits—the workflow execution is paused—until the operation is complete, fails, or times out. The default timeout value is 1800 seconds (30 minutes) and can be changed to a maximum value of 31536000 seconds (one year) for long-running operations using the connector_params field. See the Connectors reference.

The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.

The polling policy for the long-running operation can be configured. To set the connector-specific parameters (connector_params), refer to Invoke a connector call.

Arguments

Parameters
parent

string

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

string

Required. Region of the HTTP endpoint. For example, if region is set to us-central1, the endpoint https://us-central1-integrations.googleapis.com will be used. See service endpoints.
body

object (GoogleCloudAiplatformV1beta1BatchCancelPipelineJobsRequest)

Required.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
OperationError If the long-running operation finished unsuccessfully.
ResponseTypeError If the long-running operation returned a response of the wrong type.

Response

If successful, the response contains an instance of GoogleLongrunningOperation.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- batchCancel:
    call: googleapis.aiplatform.v1beta1.projects.locations.pipelineJobs.batchCancel
    args:
        parent: ...
        region: ...
        body:
            names: ...
    result: batchCancelResult

JSON

[
  {
    "batchCancel": {
      "call": "googleapis.aiplatform.v1beta1.projects.locations.pipelineJobs.batchCancel",
      "args": {
        "parent": "...",
        "region": "...",
        "body": {
          "names": "..."
        }
      },
      "result": "batchCancelResult"
    }
  }
]