長時間実行オペレーション(Advanced)

Cloud Translation API の一部のメソッドは長時間実行オペレーションを返します。これらのメソッドは非同期で、メソッドがレスポンスを返すときにオペレーションが完了していない場合があります。オペレーションのステータスを確認し、キャンセルすることもできます。

オペレーションのステータス

以下に、オペレーションのステータスをポーリングする方法を示します。

REST とコマンドライン

operation リソースの get メソッドを呼び出します。

後述のリクエストのデータを使用する前に、次のように置き換えます。

  • project-number-or-id:Google Cloud プロジェクト番号または ID
  • location-id:Cloud Storage バケット用に選択したロケーション
  • operation-id:上記で受け取ったオペレーション ID

HTTP メソッドと URL:

GET https://translation.googleapis.com/v3/projects/project-number-or-id/locations/location-id/operations/operation-id

リクエストを送信するには、次のいずれかのオプションを展開します。

次のような JSON レスポンスが返されます。

{
  "name": "projects/project-number/locations/location-id/operations/operation-id",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.translation.v3.SomeOperationMetadata",
    "state": "SUCCEEDED",
    "submitTime": "2019-11-27T22:59:40Z"
  }
}

オペレーションが完了すると、SUCCEEDEDstate の値が戻されます。

オペレーションのキャンセル

以下では、オペレーションをキャンセルする方法を示します。

REST とコマンドライン

operation リソースで cancel メソッドを呼び出します。

後述のリクエストのデータを使用する前に、次のように置き換えます。

  • project-number:Google Cloud プロジェクト番号または ID
  • location-id:Cloud Storage バケット用に選択したロケーション
  • operation-id:上記で受け取ったオペレーション ID

HTTP メソッドと URL:

POST https://translation.googleapis.com/v3/projects/project-number-or-id/locations/location-id/operations/operation-id:cancel

リクエストを送信するには、次のいずれかのオプションを展開します。

成功したことを示すステータス コード(2xx)と空のレスポンスが返されます。