Page Summary
-
This operation attempts to cancel a long-running operation asynchronously, with no guarantee of success.
-
If the server does not support cancellation, it returns
google.rpc.Code.UNIMPLEMENTED. -
Upon successful cancellation, the operation will have an
Operation.errorvalue with agoogle.rpc.Status.codeof1, corresponding toCode.CANCELLED. -
The request uses a POST HTTP method to
https://checks.googleapis.com/v1alpha/{name=accounts/*/apps/*/operations/*}:cancel. -
This operation requires the
https://www.googleapis.com/auth/checksOAuth scope for authorization.
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://checks.googleapis.com/v1alpha/{name=accounts/*/apps/*/operations/*}:cancel
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
name
|
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/checks
For more information, see the OAuth 2.0 Overview .
