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/v1/{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-01-09 UTC."],[[["This webpage outlines how to initiate the cancellation of a long-running operation via an HTTP POST request to a specified URL."],["The operation to be cancelled is identified through a `name` path parameter within the request URL."],["The request body for this operation must be empty, meaning no data is sent in the request's body."],["A successful cancellation attempt results in an empty JSON object response, while the operation's status changes to reflect the `Code.CANCELLED` state."],["Authorization for this operation requires the `https://www.googleapis.com/auth/cloud-platform` OAuth scope, as detailed in the Authentication Overview."]]],[]]
