Method: projects.operations.cancel

  • Initiates an asynchronous cancellation process for long-running operations, although cancellation success is not guaranteed.

  • The server may return an UNIMPLEMENTED error if it lacks cancellation support; use Operations.GetOperation to verify cancellation status.

  • Upon successful cancellation, the operation persists with an error code indicating cancellation instead of deletion.

  • The CancelOperation request is sent to a specific URL with the operation's name as a path parameter and an empty request body.

  • Proper authorization is needed using either earthengine or cloud-platform OAuth scopes to execute the request.

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

HTTP request

POST https://earthengine.googleapis.com/v1beta/{name=projects/*/operations/**}:cancel

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name of the operation resource to be cancelled.

Request body

The request body must be empty.

Response body

If successful, the response body is an empty JSON object.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/earthengine
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the OAuth 2.0 Overview.