Method: accounts.apps.operations.cancel

AI-generated Key Takeaways

• Asynchronously cancels a long-running operation, with success not guaranteed and the operation becoming an error with Code.CANCELLED upon successful cancellation.

• The HTTP request uses the POST method and a specific URL structure including path parameters for the operation name.

• The request body should be empty and a successful response will also result in an empty response body.

• Authorization requires the https://www.googleapis.com/auth/checks OAuth scope.

• HTTP request
• Path parameters
• Request body
• Response body
• Authorization scopes
• Try it!

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	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/checks

For more information, see the OAuth 2.0 Overview.