Method: operations.cancel
Inicia o cancelamento assíncrono de uma operação de longa duração. São feitas várias tentativas para cancelar a operação no servidor, mas o sucesso não é garantido. Se o servidor não for compatível com esse método, ele retornará google.rpc.Code.UNIMPLEMENTED
. Os clientes podem usar Operations.GetOperation
ou outros métodos para verificar se o cancelamento ocorreu ou se a operação foi concluída mesmo com o cancelamento. Se o cancelamento for bem-sucedido, a operação não será excluída. Em vez disso, ela se tornará uma operação com um valor Operation.error
que tem um google.rpc.Status.code
de 1
, correspondente a Code.CANCELLED
.
Solicitação HTTP
POST https://vault.googleapis.com/v1/{name=operations/**}:cancel
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros |
name |
string
O nome do recurso de operação a ser cancelado.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta será um objeto JSON vazio.
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/ediscovery
Para mais informações, consulte OAuth 2.0 Overview.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-02-06 UTC.
[null,null,["Última atualização 2025-02-06 UTC."],[[["Initiates the cancellation process for a long-running operation, although cancellation success is not guaranteed."],["Uses the `POST` method with a specific URL structure including the operation name for cancellation."],["Requires an empty request body and returns an empty response body upon successful cancellation."],["In case of unsupported cancellation by the server, an `UNIMPLEMENTED` error code is returned."],["If cancelled successfully, the operation is not deleted but marked with a `CANCELLED` status code."]]],["This document details the process of initiating asynchronous cancellation for a long-running operation. It uses an HTTP POST request to `vault.googleapis.com/v1/{name=operations/**}:cancel`. The `name` parameter specifies the operation to cancel. The request body must be empty, and a successful response returns an empty JSON object. The server attempts cancellation, and clients can check the status via `Operations.GetOperation`. Successful cancellation results in an `Operation.error` with `Code.CANCELLED`. Authorization requires the `https://www.googleapis.com/auth/ediscovery` OAuth scope.\n"]]