Method: projects.operations.cancel

  • Initiates an asynchronous cancellation request for a long-running Earth Engine operation, with no guarantee of success and returning an UNIMPLEMENTED error if unsupported by the server.

  • Upon successful cancellation, the operation is marked with a Code.CANCELLED error but is not deleted, and users can monitor its status through methods like Operations.GetOperation.

  • The cancellation request is made using an HTTP POST to a specific URL, requires an empty request body, and uses the operation's name as a path parameter.

  • To authorize the request, either the earthengine or cloud-platform OAuth scope is necessary.

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/v1/{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.