Method: googleapis.documentai.v1beta3.projects.locations.operations.cancel

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.

Arguments

Parameters
name	string Required. The name of the operation resource to be cancelled.
location	string Location of the HTTP endpoint: us or eu. If not set, us is used by default.

Raised exceptions

Exceptions
ConnectionError	In case of a network problem (such as DNS failure or refused connection).
HttpError	If the response status is >= 400 (excluding 429 and 503).
TimeoutError	If a long-running operation takes longer to finish than the specified timeout limit.
TypeError	If an operation or function receives an argument of the wrong type.
ValueError	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response will be empty.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- cancel:
    call: googleapis.documentai.v1beta3.projects.locations.operations.cancel
    args:
        name: ...
    result: cancelResult

JSON

[
  {
    "cancel": {
      "call": "googleapis.documentai.v1beta3.projects.locations.operations.cancel",
      "args": {
        "name": "..."
      },
      "result": "cancelResult"
    }
  }
]