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://{TRANSLATION_GDC_ENDPOINT}/v3/{name}:cancel
Path parameters
Parameters
name
string
The name of the operation resource to be cancelled.
[[["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-07-10 UTC."],[[["\u003cp\u003eThis API call initiates the cancellation of a long-running operation, with no guarantee of success.\u003c/p\u003e\n"],["\u003cp\u003eClients can verify the cancellation's outcome or operation completion status through \u003ccode\u003eOperations.GetOperation\u003c/code\u003e or alternative methods.\u003c/p\u003e\n"],["\u003cp\u003eA successful cancellation results in the operation receiving an error status indicating \u003ccode\u003eCode.CANCELLED\u003c/code\u003e, rather than deletion.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request for cancellation is a POST request to a specific endpoint, requiring the operation's name in the path and an empty request body.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires either the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-translation\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\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` 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](/distributed-cloud/hosted/docs/latest/gdch/apis/vertex-ai/translation/rest/v3/projects.operations#Operation.FIELDS.error) value with a [google.rpc.Status.code](/distributed-cloud/hosted/docs/latest/gdch/apis/vertex-ai/translation/rest/v3/projects.operations#Status.FIELDS.code) of 1, corresponding to `Code.CANCELLED`.\n\n### HTTP request\n\n`POST https://{TRANSLATION_GDC_ENDPOINT}/v3/{name}:cancel`\n\n### Path parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body is empty.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-translation`\n- `https://www.googleapis.com/auth/cloud-platform`"]]
