REST Resource: projects.locations.flags

資源：Flag

代表單一 Flag。

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

ID。資源名稱 (資源的完整 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 通常是由伺服器在成功建立資源時產生，且不可變更。資源名稱會重複使用，因此您可以使用 UID 明確識別資源。這應為 UUID4。
etag

string

僅供輸出。能明確識別版本或產生資源的不透明值。可用來確認用戶端和伺服器同意寫入資源的順序。
createTime

string (Timestamp format)

僅供輸出。資源的建立時間戳記。

使用 RFC 3339，產生的輸出內容一律會經過 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 正規化，並使用 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 雙旗標類型。

ValueType (值類型)

旗標值類型。

列舉
FLAG_VALUE_TYPE_UNSPECIFIED 未指定旗標值類型。
FLAG_VALUE_TYPE_BOOLEAN 布林值標記值類型。
FLAG_VALUE_TYPE_INTEGER 整數旗標值類型。
FLAG_VALUE_TYPE_STRING 字串旗標值類型。
FLAG_VALUE_TYPE_DOUBLE Double 旗標值類型。

FlagVariant

變數是值的 ID (指派給值的名稱)。

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 會根據服務範圍內變體的名稱和值而有所不同。這個 ID 通常是由伺服器產生，且不得變更。trackingId 用於追蹤及識別變體。
description

string

選用。使用者可理解的說明，指出這個變體的作用或代表的意義。
聯集欄位 value。值是變體的單一旗標值。value 只能是下列其中一個設定：
booleanValue

boolean

選用。布林變數值。
integerValue

string (int64 format)

選用。整數變數值。
stringValue

string

選用。字串變數值。
doubleValue

number

選用。子類值重複。

狀態

「狀態」會定義旗標的狀態。

列舉
FLAG_STATE_UNSPECIFIED 未指定標記狀態。
FLAG_STATE_IN_DEVELOPMENT 旗標處於開發狀態。
FLAG_STATE_ACTIVE 旗標處於有效狀態。
FLAG_STATE_SUNSETTING 旗標處於已淘汰狀態。
FLAG_STATE_CLEANUP 旗標處於清除狀態。

方法

create

 建立新旗標。

delete

 刪除單一標記。

get

 擷取單一標記。

list

 擷取一組旗標。

patch

 更新單一標記。