REST Resource: projects.locations.flags

资源:标志

表示单个标志。

JSON 表示法
{
  "name": string,
  "key": string,
  "valueType": enum (FlagValueType),
  "flagValueType": enum (ValueType),
  "evaluationSpec": {
    object (EvaluationSpec)
  },
  "unitKind": string,
  "description": string,
  "variants": [
    {
      object (FlagVariant)
    }
  ],
  "flagSet": string,
  "state": enum (State),
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string
}
字段
name

string

标识符。遵循标准命名方案的资源名称(资源的完整 URI):

"projects/{project}/locations/{location}/flags/{flagId}"

key

string

必需。不可变。运行时评估 API (OpenFeature) 中使用的标志键。长度上限:256 字节。

valueType
(deprecated)

enum (FlagValueType)

可选。不可变。已弃用:请改用 flagValueType。标志值类型。

flagValueType

enum (ValueType)

可选。不可变。标志值类型。

evaluationSpec

object (EvaluationSpec)

可选。有关如何评估标志值的规范。

如果创建的布尔值标志未指定 evaluationSpec,系统会默认创建两个默认变体:“已启用”(boolValue = true)和“已停用”(boolValue = false),并将“已停用”设置为 defaultTarget。

unitKind

string

必需。不可变。UnitKind 可以使用此标志。

description

string

可选。标志的说明。长度上限:500 字节。

variants[]

object (FlagVariant)

可选。变体的列表。

flagSet

string

可选。相应标志所属的标志集。

state

enum (State)

可选。标志的当前状态。

labels

map (key: string, value: string)

可选。资源上的标签,可用于分类。与 Kubernetes 资源标签类似。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

annotations

map (key: string, value: string)

可选。注解是与资源一起存储的非结构化键值对映射,可由外部工具设置,用于存储和检索任意元数据。它们无法查询,并且在修改对象时应予以保留。

如需了解详情,请参阅 https://kubernetes.io/docs/user-guide/annotations

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

uid

string

仅限输出。资源的唯一标识符。在服务范围内,UID 在此资源的时间和空间内是唯一的。它通常是服务器在成功创建资源时生成的,不得进行更改。当存在资源名称重用时,UID 可用来唯一地标识资源。此字段应为 UUID4。

etag

string

仅限输出。不透明值,用于唯一地标识资源的版本或世代。它可用于确认客户端和服务器是否就正在写入的资源的顺序达成一致。

createTime

string (Timestamp format)

仅限输出。创建资源时的时间戳。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

updateTime

string (Timestamp format)

仅限输出。上次更新资源时的时间戳。用户对此资源的任何更改都必须刷新此值。服务对资源的更改应刷新此值。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

FlagValueType

枚举
FLAG_VALUE_TYPE_UNSPECIFIED
FLAG_VALUE_TYPE_BOOL 布尔值标志值类型。
FLAG_VALUE_TYPE_INT 整数标志值类型。
FLAG_VALUE_TYPE_STRING 字符串标志值类型。
FLAG_VALUE_TYPE_DOUBLE double 标志类型。

ValueType

标志值类型。

枚举
FLAG_VALUE_TYPE_UNSPECIFIED 未指定标志值类型。
FLAG_VALUE_TYPE_BOOLEAN 布尔值标志值类型。
FLAG_VALUE_TYPE_INTEGER 整数标志值类型。
FLAG_VALUE_TYPE_STRING 字符串标志值类型。
FLAG_VALUE_TYPE_DOUBLE 双精度标志值类型。

FlagVariant

变体是值的标识符(分配给值的名称)。

JSON 表示法
{
  "id": string,
  "trackingId": string,
  "description": string,

  // Union field value can be only one of the following:
  "booleanValue": boolean,
  "integerValue": string,
  "stringValue": string,
  "doubleValue": number
  // End of list of possible types for union field value.
}
字段
id

string

必需。变体 ID。长度上限:128 字节。

trackingId

string

可选。trackingId 在服务范围内是唯一的,具体取决于变体的名称和值。它通常由服务器生成,不得进行更改。trackingId 用于唯一标识和跟踪变体。

description

string

可选。此变体的功能或代表的含义的人类可读说明。

联合字段 value。value 是变体的单个标志值。value 只能是下列其中一项:
booleanValue

boolean

可选。布尔值变体。

integerValue

string (int64 format)

可选。整数变体值。

stringValue

string

可选。字符串变体值。

doubleValue

number

可选。双精度变体值。

State 定义标志的状态。

枚举
FLAG_STATE_UNSPECIFIED 标志状态未指定。
FLAG_STATE_IN_DEVELOPMENT 标志处于开发状态。
FLAG_STATE_ACTIVE 标志处于活跃状态。
FLAG_STATE_SUNSETTING 标志处于已弃用状态。
FLAG_STATE_CLEANUP 标志处于清理状态。

方法

create

创建新标志。

delete

删除单个标志。

get

检索单个标志。

list

检索标志集合。

patch

更新单个标志。