Announcement: All noncommercial projects registered to use Earth Engine before April 15, 2025 must verify noncommercial eligibility to maintain Earth Engine access.
Stay organized with collections
Save and categorize content based on your preferences.
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
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-06 UTC."],[[["\u003cp\u003eInitiates an asynchronous cancellation request for a long-running Earth Engine operation, with no guarantee of success and returning an \u003ccode\u003eUNIMPLEMENTED\u003c/code\u003e error if unsupported by the server.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful cancellation, the operation is marked with a \u003ccode\u003eCode.CANCELLED\u003c/code\u003e error but is not deleted, and users can monitor its status through methods like \u003ccode\u003eOperations.GetOperation\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe 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.\u003c/p\u003e\n"],["\u003cp\u003eTo authorize the request, either the \u003ccode\u003eearthengine\u003c/code\u003e or \u003ccode\u003ecloud-platform\u003c/code\u003e OAuth scope is necessary.\u003c/p\u003e\n"]]],["This content details the process for asynchronously canceling a long-running operation. Users initiate cancellation via a POST request to a specified URL, providing the operation's name. The server attempts cancellation, potentially returning `UNIMPLEMENTED`. Clients check the operation's status using `GetOperation`. Successful cancellation results in an operation with an error code `1` (`CANCELLED`), and the operation isn't deleted. The request body is empty, and the response, if successful, is also empty. Specific OAuth scopes are required.\n"],null,["# Method: projects.operations.cancel\n\nStarts 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](/earth-engine/reference/rest/v1alpha/projects.operations/get#google.longrunning.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](/earth-engine/reference/rest/Shared.Types/ListOperationsResponse#Operation.FIELDS.error) value with a [google.rpc.Status.code](/earth-engine/reference/rest/Shared.Types/ListOperationsResponse#Status.FIELDS.code) of `1`, corresponding to `Code.CANCELLED`.\n\n### HTTP request\n\n`POST https://earthengine.googleapis.com/v1/{name=projects/*/operations/**}:cancel`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------|\n| `name` | `string` The name of the operation resource to be cancelled. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body is an empty JSON object.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/earthengine`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]