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/*/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 details the process of canceling a long-running operation via an HTTP POST request to a specific URL, using gRPC Transcoding."],["Cancellation is initiated through the `Operations.CancelOperation` method and does not guarantee success, with the server making a best effort to fulfill the request."],["The request is sent with an empty body, and the URL contains a path parameter `name` to identify the operation to be cancelled."],["A successful operation cancellation will result in an empty JSON object response and the operation's status being updated to `Code.CANCELLED`."],["Authorization for this operation requires the OAuth scope `https://www.googleapis.com/auth/cloud-platform`."]]],[]]
