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/*/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."],[[["This webpage outlines how to initiate the asynchronous cancellation of a long-running operation via an HTTP POST request to a specific URL."],["The request requires specifying the operation's resource name in the URL's path parameters and that the request body must be empty."],["Upon successful cancellation, the operation will have an error code indicating it was cancelled, and the response body will be an empty JSON object."],["Authorization for this request requires the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."],["Cancelling an operation does not guarantee success, and can be checked via `Operations.GetOperation` method."]]],[]]
