Flag

A flag controlling how entities are assigned variants.

displayName

string

required

The display name of the flag. For example: my-flag

state

enum<string>

required

The current state of the flag.

Available options:

STATE_UNSPECIFIED,

ACTIVE,

ARCHIVED

createTime

object

required

Time when the flag was first created.

updateTime

object

required

Time when the flag was last updated.

creator

string

required

Reference to the identity that created this flag.

updater

string

required

Reference to the identity that last updated this flag.

name

string

The resource name of the flag. For example: flags/my-flag

description

string

A description for the flag.

schema

object

Schema for the value of each variant.

Show child attributes

variants

Flag.Variant · object[]

Flag.Variant: List of variants for this flag. When a client resolves this flag, it will be assigned exactly one of the variants in this list along with its value.

Show child attributes

rules

Flag.Rule · object[]

Flag.Rule: List of ordered rules that determines how entities are assigned to variants. When a client resolves this flag, each rule will be tried in order, the first rule that match, will provide a variant assignment. If not rule matches, no variant will be assigned.

Show child attributes

clients

string[]

List of clients that this flag is enabled for.

archiveTime

object

Time when the flag was archived.

labels

object[]

General labels for this flag.

Show child attributes

usageMetadata

object

Semi-realtime usage statistics for the flag.

Show child attributes

owner

string

The owner of the resource. If not set will default to the creator.

Flag.Rule

⌘I

{
  "displayName": "<string>",
  "state": "STATE_UNSPECIFIED",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "description": "<string>",
  "schema": {
    "schema": [
      {}
    ]
  },
  "variants": [
    {
      "name": "<string>",
      "value": {},
      "createTime": {},
      "updateTime": {},
      "creator": "<string>",
      "updater": "<string>",
      "labels": [
        {}
      ],
      "description": "<string>",
      "imageUri": "<string>"
    }
  ],
  "rules": [
    {
      "segment": "<string>",
      "assignmentSpec": {
        "bucketCount": {},
        "assignments": [
          {
            "assignmentId": "<string>",
            "variant": {
              "variant": "<string>"
            },
            "fallthrough": {},
            "clientDefault": {},
            "bucketRanges": [
              {
                "lower": {},
                "upper": {}
              }
            ]
          }
        ]
      },
      "usageMetadata": {
        "resolveCount": 123,
        "applyCount": 123,
        "lastResolveTime": {},
        "lastApplyTime": {},
        "assignmentUsageMetadata": [
          {
            "assignmentId": "<string>",
            "resolveCount": 123,
            "applyCount": 123,
            "lastApplyTime": {},
            "emptyTargetingKeyCount": 123
          }
        ]
      },
      "enabled": true,
      "createTime": {},
      "updateTime": {},
      "creator": "<string>",
      "updater": "<string>",
      "name": "<string>",
      "description": "<string>",
      "targetingKeySelector": "<string>",
      "environments": [
        "<string>"
      ],
      "labels": [
        {}
      ],
      "materializationSpec": {
        "writeMaterialization": "<string>",
        "readMaterialization": "<string>",
        "mode": {
          "materializationMustMatch": true,
          "segmentTargetingCanBeIgnored": true
        }
      }
    }
  ],
  "clients": [
    "<string>"
  ],
  "archiveTime": {},
  "labels": [
    {}
  ],
  "usageMetadata": {
    "resolveCount": 123,
    "lastResolveTime": {},
    "lastApplyTime": {}
  },
  "owner": "<string>"
}

Get Started

Feature Flags

Metrics

Stats

Experiments

Surfaces

IAM

Connectors