Method: enterprises.devices.operations.cancel

AI-generated Key Takeaways

• Cancels a long-running operation asynchronously, with the server making a best effort to cancel the operation but success is not guaranteed.

• Uses an HTTP POST request to https://androidmanagement.googleapis.com/v1/{name=enterprises/*/devices/*/operations/*}:cancel with the operation name as a path parameter and an empty request body.

• If cancellation is successful, the response body will be empty and the operation will have an error value with a code of 1, indicating cancellation.

• Requires authorization with the https://www.googleapis.com/auth/androidmanagement 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://androidmanagement.googleapis.com/v1/{name=enterprises/*/devices/*/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 an empty JSON object.

Authorization scopes

Requires the following OAuth scope:

• https://www.googleapis.com/auth/androidmanagement

For more information, see the OAuth 2.0 Overview.