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 returnsgoogle.rpc.Code.UNIMPLEMENTED. Clients can useOperations.GetOperationor 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 anOperation.errorvalue with agoogle.rpc.Status.codeof 1, corresponding toCode.CANCELLED.
HTTP request
POST https://adsdatahub.googleapis.com/v1/{name=operations/**}:cancel
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eInitiates asynchronous cancellation for long-running operations, although success isn't guaranteed.\u003c/p\u003e\n"],["\u003cp\u003eIf the server supports cancellation, the operation is marked with an error code indicating cancellation but isn't deleted.\u003c/p\u003e\n"],["\u003cp\u003eClients should use Operations.GetOperation to verify cancellation status or operation completion.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes an HTTP POST request with specific path parameter for the operation to be cancelled.\u003c/p\u003e\n"],["\u003cp\u003eRequires the 'https://www.googleapis.com/auth/adsdatahub' OAuth scope for authorization.\u003c/p\u003e\n"]]],["The provided content outlines the process for canceling a long-running operation via an HTTP POST request to a specific URL (`https://adsdatahub.googleapis.com/v1/{name=operations/**}:cancel`). The `name` parameter, specifying the operation to cancel, is required in the URL. The request body must be empty, and a successful cancellation yields an empty response body. Successful cancellation changes operation status to `Code.CANCELLED`. Authorization requires the `https://www.googleapis.com/auth/adsdatahub` OAuth scope.\n"],null,["# Method: operations.cancel\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\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](/ads-data-hub/marketers/reference/rest/v1/operations/get#google.longrunning.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](/ads-data-hub/marketers/reference/rest/v1/operations#Operation.FIELDS.error) value with a [google.rpc.Status.code](/ads-data-hub/marketers/reference/rest/v1/operations#Status.FIELDS.code) of 1, corresponding to `Code.CANCELLED`.\n\n### HTTP request\n\n`POST https://adsdatahub.googleapis.com/v1/{name=operations/**}:cancel`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------|\n| `name` | `string` The name of the operation resource to be cancelled. |\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 the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adsdatahub`"]]
