AI-generated Key Takeaways
-
The
cancelmethod initiates asynchronous cancellation of a long-running operation, although success is not guaranteed. -
Servers that do not support this method will return
google.rpc.Code.UNIMPLEMENTED. -
Clients can check the status of the operation after attempting cancellation using
Operations.GetOperationor similar methods. -
Upon successful cancellation, the operation's status is updated with a
google.rpc.Code.CANCELLEDerror code, and the operation is not deleted. -
The request uses an HTTP POST method to a specific URL containing the operation name and requires specific OAuth scopes for authorization.
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
|
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 .
