メソッド: projects.configs.variables.watch

特定の変数を監視し、変数の値の変化を待ちます。変更がある場合、このメソッドは新しい値を返すか、タイムアウトします。

監視中に変数が削除された場合、variableState 状態が DELETED に設定され、メソッドは最後の既知の変数 value を返します。

監視期限を内部のタイムアウト(60 秒)よりも大きな値に設定した場合、現在の変数値が返され、variableStateVARIABLE_STATE_UNSPECIFIED となります。

ウォッチャーの作成の詳細については、変数の変更を監視するをご覧ください。

HTTP リクエスト

POST https://runtimeconfig.googleapis.com/v1beta1/{name=projects/*/configs/*/variables/**}:watch

この URL は Google API HTTP アノテーション構文を使用します。

パスパラメータ

パラメータ
name

string

監視する変数の名前:

projects/[PROJECT_ID]/configs/[CONFIG_NAME]

リクエストの本文

リクエストの本文には、次の構造を使用したデータが含まれています。

JSON 表現

{
  "newerThan": string,
}
フィールド
newerThan

string (Timestamp format)

指定された場合は、変数の現在のタイムスタンプをチェックし、現在のタイムスタンプ newerThan タイムスタンプより新しい場合、メソッドはすぐに戻ります。

指定されない、または変数が古いタイムスタンプを持つ場合は、ウォッチャーは返る前に、値が変わるのを待ちます。

RFC3339 UTC 「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"

レスポンスの本文

成功した場合、レスポンスの本文には Variable のインスタンスが含まれます。

承認

以下のいずれかの OAuth スコープを設定する必要があります。

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

詳細は、Auth ガイドを参照してください。

試してみましょう