Method: operations.cancel
長時間実行オペレーションの非同期キャンセルを開始します。サーバーは操作のキャンセルに全力を尽くしますが、成功は保証されません。このメソッドがサーバーでサポートされていない場合は、google.rpc.Code.UNIMPLEMENTED
を返します。クライアントは Operations.GetOperation
などのメソッドを使用して、キャンセルが成功したか、あるいはキャンセルしたにもかかわらずオペレーションが完了したかを確認できます。キャンセルが成功するとそのオペレーションは削除されず、google.rpc.Status.code
が 1 の Operation.error
値を持つオペレーションになります。これは Code.CANCELLED
に相当します。
HTTP リクエスト
POST https://adsdatahub.googleapis.com/v1/{name=operations/**}:cancel
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
name |
string
キャンセルするオペレーション リソースの名前。
|
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文は空になります。
認証スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/adsdatahub
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2022-09-26 UTC。
[null,null,["最終更新日 2022-09-26 UTC。"],[[["Initiates asynchronous cancellation for long-running operations, although success isn't guaranteed."],["If supported, the server attempts cancellation; otherwise, it returns an `UNIMPLEMENTED` error."],["Upon successful cancellation, the operation is marked with an error code indicating cancellation, but it is not deleted."],["Clients can monitor cancellation status or operation completion via methods like `Operations.GetOperation`."],["Requires the `https://www.googleapis.com/auth/adsdatahub` OAuth scope for authorization."]]],[]]