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://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/operations/*}:cancel
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThis API method initiates the cancellation of a long-running operation, attempting to stop its execution, though success isn't guaranteed.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request to cancel an operation is made via a POST request to a specific URL, following gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe API method requires a \u003ccode\u003ename\u003c/code\u003e path parameter to specify the operation resource to be cancelled.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for cancelling an operation must be empty, with no data needed.\u003c/p\u003e\n"],["\u003cp\u003eA successful cancellation results in an empty JSON object response, indicating the cancellation request was accepted, and it also requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,[]]
