Method: operations.cancel
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://adsdatahub.googleapis.com/v1/{name=operations/**}:cancel
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
The name of the operation resource to be cancelled.
|
Request body
The request body must be empty.
Response body
If successful, the response body is empty.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/adsdatahub
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["Initiates asynchronous cancellation for long-running operations, although success isn't guaranteed."],["If the server supports cancellation, the operation is marked with an error code indicating cancellation but isn't deleted."],["Clients should use Operations.GetOperation to verify cancellation status or operation completion."],["Utilizes an HTTP POST request with specific path parameter for the operation to be cancelled."],["Requires the 'https://www.googleapis.com/auth/adsdatahub' OAuth scope for authorization."]]],["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"]]
