Method: projects.configs.variables.watch

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

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

監視の期限を内部タイムアウト（60 秒）より大きい値に設定すると、現在の変数値が返され、variableState は VARIABLE_STATE_UNSPECIFIED になります。

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
name

string

監視する変数の名前:

projects/[PROJECT_ID]/configs/[CONFIG_NAME]

認可には、指定されたリソース name に対する次の Google IAM 権限が必要です。

  • runtimeconfig.variables.watch

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

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

詳細については、認証の概要をご覧ください。

試してみる