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.

Source: R/firestore_functions.R

Autogenerated via gar_create_api_skeleton

projects.databases.operations.cancel(
  GoogleLongrunningCancelOperationRequest,
  name
)

Arguments

GoogleLongrunningCancelOperationRequest

The GoogleLongrunningCancelOperationRequest object to pass to this method

name

The name of the operation resource to be cancelled

Details

Authentication scopes used by this function are:

  • https://www.googleapis.com/auth/cloud-platform

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

Set options(googleAuthR.scopes.selected = c(https://www.googleapis.com/auth/cloud-platform, https://www.googleapis.com/auth/datastore) Then run googleAuthR::gar_auth() to authenticate. See gar_auth for details.

See also

Google Documentation

Other GoogleLongrunningCancelOperationRequest functions: GoogleLongrunningCancelOperationRequest()