REST Resource: 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 つ以上含める必要があります。複数のスラッシュは、単一のスラッシュ文字に合体されています。各パスセグメントは、正規表現 0-9A-Za-z? と一致する必要があります。[VARIABLE_NAME] の長さは 256 文字未満にする必要があります。

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

string (Timestamp format)

出力専用。変数が最後に更新された時刻。タイムスタンプは UTC タイムスタンプになります。

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

enum(VariableState)

出力専用。変数の現在の状態。変数の状態は、variables().watch 呼び出しの結果を示します。この状態は、get 呼び出しと list 呼び出しで確認できます。
共用体フィールド contents。変数の値。バイナリまたは文字列値のいずれかになります。value または text のいずれかを指定する必要があります。両方を指定すると、サーバーはエラーを返します。contents は次のいずれかになります。
value

string (bytes format)

変数のバイナリ値。値の長さは 4096 バイト未満にしてください。空の値も受け入れられます。値は Base64 でエンコードし、IETF RFC4648（https://www.ietf.org/rfc/rfc4648.txt）に準拠している必要があります。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

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

testIamPermissions

 指定したリソースに対して呼び出し元が持っている権限を返します。

update

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

watch

 特定の変数を監視し、変数の値の変化を待ちます。