Method: transferOperations.cancel

転送をキャンセルします。transferOperations.get メソッドを使用して、キャンセルが成功したかどうか、または cancel リクエストにもかかわらずオペレーションが完了したかどうかを確認します。

オペレーションをキャンセルすると、現在実行中の転送が中断されます。定期的な転送ジョブの場合、転送ジョブの次のインスタンスは引き続き実行されます。たとえば、ジョブが毎日午後 1 時に実行されるように構成されていて、月曜日の処理を午後 1 時 5 分にキャンセルした場合、月曜日の転送は停止します。ただし、火曜日には転送ジョブが試行されます。

これは、現在実行中のオペレーションにのみ適用されます。オペレーションが現在実行されていない場合、cancel は何もしません。

ジョブをキャンセルすると、次のジョブでファイルのデルタが計算され、不整合な状態が修復される場合があります。たとえば、ジョブを毎日実行していて、今日のジョブで 10 個の新しいファイルが検出され、ジョブをキャンセルする前に 5 個のファイルが転送された場合、明日の転送オペレーションでは、今日コピーされなかった 5 個のファイルと、明日検出された新しいファイルで新しい差分計算が行われます。

HTTP リクエスト

POST https://storagetransfer.googleapis.com/v1/{name=transferOperations/**}:cancel

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

キャンセルするオペレーション リソースの名前。

リクエストの本文

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

レスポンスの本文

成功すると、レスポンスの本文は空の JSON オブジェクトになります。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。