コレクション: projects.configs.variables

リソース: 変数

RuntimeConfig リソース内の単一の変数について説明します。名前は、階層変数名を示しています。たとえば、ports/serving_port が有効な変数名です。変数の値は不完全文字列であり、葉変数だけが値(つまり、まったく子変数を持っていない変数)を持つことができます。

JSON 表現

{
  "name": string,
  "updateTime": string,
  "state": enum(VariableState),

  // Union field contents can be only one of the following:
  "value": string,
  "text": string,
  // End of list of possible types for union field contents.
}
フィールド
name

string

変数リソースの名前:


projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]

[PROJECT_ID] には有効なプロジェクト ID、[CONFIG_NAME] には有効な RuntimeConfig リソースを入れる必要があります。[VARIABLE_NAME] は Unix ファイル システムのファイルパスのネーミングに従います。

[VARIABLE_NAME] には ASCII 文字、数字、スラッシュとダッシュを含めることができます。スラッシュはパス要素のセパレータとして使用され、それ自体 [VARIABLE_NAME] の一部ではないため、[VARIABLE_NAME] には少なくとも 1 つのスラッシュではない文字を含める必要があります。複数のスラッシュは、単一のスラッシュ文字に合体されています。各パスセグメントは、RFC 1035 のセグメントの仕様に従ってください。[VARIABLE_NAME] の長さは 256 バイト未満にしてください。

いったん変数を作成したら、変数名を変更することはできません。

updateTime

string (Timestamp format)

[出力専用] 最後に変数が更新された時刻。

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

state

enum(VariableState)

[出力専用] 変数の現在の状態。変数の状態は variables().watch コールの結果を示し、getlist のコールを通じて可視となります。

Union フィールド contents。変数の値。バイナリまたは文字列値のいずれかになります。value または text いずれかを指定する必要があります。両方を指定すると、サーバーがエラーを返すことになります。contents は、以下のいずれかになります。
value

string (bytes format)

変数のバイナリ値。値の長さは 4096 バイト未満にしてください。空の値も受け入れられます。値は、base64 でエンコードする必要があります。設定できるのは、value または text のいずれかになります。

base64 でエンコードされた文字列。

text

string

変数の文字列値。値の長さは 4096 バイト未満にしてください。空の値も受け入れられます。たとえば text: "my text value" のようになります。文字列は有効な UTF-8 でなければなりません。

VariableState

VariableState は、変数の最後の既知の状態を記述し、variables().watch コール中に変数の状態を区別するために使用されます。

列挙値
VARIABLE_STATE_UNSPECIFIED デフォルトの変数の状態。
UPDATED variables().watch が実行された一方で、変数が更新されました。
DELETED variables().watch が実行された一方で、変数が削除されました。

メソッド

create

指定された設定内で変数を作成します。

delete

変数または複数の変数を削除します。

get

単一の変数に関する情報を取得します。

list

任意の設定内で、設定されたすべてのフィルタにマッチする変数を一覧表示します。

update

新しい値で既存の変数を更新します。

watch

特定の変数を監視し、変数の値の変化を待ちます。
このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...