Method: projects.databases.operations.cancel

長時間実行操作で非同期キャンセルを開始します。サーバーは操作をキャンセルするために最善の努力をしますが、成功は保証されません。サーバーがこのメソッドをサポートしていない場合は、 google.rpc.Code.UNIMPLEMENTEDを返します。クライアントは、 Operations.GetOperationまたはその他のメソッドを使用して、キャンセルが成功したかどうか、またはキャンセルにもかかわらず操作が完了したかどうかを確認できます。キャンセルが成功しても、操作は削除されません。代わりに、 Code.CANCELLEDに対応する、 google.rpc.Status.codeが 1 のOperation.error値を持つ操作になります。

HTTPリクエスト

POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*/operations/*}:cancel

URL はgRPC トランスコーディング構文を使用します。

パスパラメータ

パラメーター
name

string

キャンセルする操作リソースの名前。

リクエストボディ

リクエストの本文は空である必要があります。

レスポンスボディ

成功した場合、応答本文は空になります。

認可範囲

次の OAuth スコープのいずれかが必要です。

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

詳細については、 「認証の概要」を参照してください。