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

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 を指定せずにブール値フラグを作成すると、デフォルトで「Enabled」（boolValue = true）と「Disabled」（boolValue = false）の 2 つのデフォルト バリアントが作成され、「Disabled」が 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)

省略可。アノテーションは、任意のメタデータを保存して取得するため、外部ツールによって設定される可能性のあるリソースとともに保存される非構造化 Key-Value マップです。クエリは実行可能ではなく、オブジェクトを変更する際に保持する必要があります。

詳細: 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 正規化され、小数点以下は 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 double 型のフラグ。

ValueType

フラグ値の型。

列挙型
FLAG_VALUE_TYPE_UNSPECIFIED フラグ値の型が指定されていません。
FLAG_VALUE_TYPE_BOOLEAN ブール値フラグ値の型。
FLAG_VALUE_TYPE_INTEGER 整数フラグ値の型。
FLAG_VALUE_TYPE_STRING 文字列フラグ値の型。
FLAG_VALUE_TYPE_DOUBLE 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

省略可。double バリエーション値。

状態

State は、フラグの状態を定義します。

列挙型
FLAG_STATE_UNSPECIFIED フラグの状態が指定されていません。
FLAG_STATE_IN_DEVELOPMENT フラグが開発状態です。
FLAG_STATE_ACTIVE フラグがアクティブな状態です。
FLAG_STATE_SUNSETTING フラグが非推奨の状態です。
FLAG_STATE_CLEANUP フラグがクリーンアップ状態です。

メソッド

create

 新しいフラグを作成します。

delete

 1 つのフラグを削除します。

get

 単一のフラグを取得します。

list

 フラグのコレクションを取得します。

patch

 単一のフラグを更新します。