AI-generated Key Takeaways
-
Asynchronous cancellation is attempted on a long-running operation, but success is not guaranteed and the server may not support this method.
-
You can check the operation's status after attempting cancellation using
Operations.GetOperationor other methods. -
A successful cancellation results in an operation with an error value and a status code of
1(CANCELLED), and the operation is not deleted. -
The HTTP request for cancellation uses a POST method with a specific URL structure including the operation's name as a path parameter.
-
Authorization requires one of the listed OAuth scopes.
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
|
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 .
