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] 必须包含至少一个非斜线字符。多个斜杠会合并为单个斜杠字符。每个路径段都应与 0-9A-Za-z? 正则表达式匹配。[VARIABLE_NAME] 的长度必须少于 256 个字符。

变量创建后,您将无法更改变量名称。

updateTime

string (Timestamp format)

仅限输出。上次更新变量的时间。时间戳将采用世界协调时间 (UTC) 格式。

此时间戳采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,且精确到纳秒。示例:"2014-10-02T15:01:23.045123456Z"

state

enum(VariableState)

仅限输出。变量的当前状态。变量状态表示 variables().watch 调用的结果,可通过 getlist 调用查看。

联合字段 contents。变量的值。它可以是二进制值或字符串值。您必须指定 valuetext 中的一个。同时指定这两项将导致服务器返回错误。contents 只能是下列其中一项:
value

string (bytes format)

变量的二进制值。值的长度不得超过 4096 字节。也可以使用空值。该值必须采用 base64 编码,并且必须符合 IETF RFC4648 (https://www.ietf.org/rfc/rfc4648.txt) 标准。只能设置 valuetext 之一。

使用 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

监控特定变量,并等待变量值发生变化。