Method: operations.cancel

Page Summary

• This API call initiates the cancellation of a long-running operation, with no guarantee of success, indicated by an UNIMPLEMENTED error if not supported by the server.

• The HTTP request is a POST method to a specific URL using gRPC Transcoding syntax, formatted as https://routeoptimization.googleapis.com/v1/{name=operations/**}:cancel.

• The name path parameter is a string that represents the operation's resource name, which is required to identify the operation to cancel.

• The request body for canceling an operation must be empty, and a successful response will also have an empty body.

• This operation requires the https://www.googleapis.com/auth/cloud-platform OAuth scope for authorization.

• HTTP request
• Path parameters
• Request body
• Response body
• Authorization scopes

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://routeoptimization.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/cloud-platform