Method: operations.cancel

AI-generated Key Takeaways

• Initiates asynchronous cancellation for long-running operations, although success isn't guaranteed.

• If supported, the server attempts cancellation; otherwise, it returns an UNIMPLEMENTED error.

• Upon successful cancellation, the operation is marked with an error code indicating cancellation, but it is not deleted.

• Clients can monitor cancellation status or operation completion via methods like Operations.GetOperation.

• Requires the https://www.googleapis.com/auth/adsdatahub 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://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