REST Resource: projects.locations.instances.features

Resource: Feature

Represents a feature flag for a Chronicle feature. Features allow customers to enable or disable new Chronicle capabilities during preview stages (e.g., Public Preview). Once a feature reaches General Availability, it is enabled by default for all customers and can no longer be disabled.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "enabled": boolean,
  "publicDocumentationLink": string,
  "stage": enum (FeatureStage),
  "expectedRetirementDate": {
    object (Date)
  },
  "category": enum (FeatureCategory),
  "prerequisiteFeatures": [
    string
  ],
  "dependentFeatures": [
    string
  ]
}
Fields
name

string

Identifier. The resource name of the Feature. Format: projects/{project}/locations/{location}/instances/{instance}/features/{feature}
displayName

string

Output only. The human-readable display name for the feature.
description

string

Output only. Description of the feature.
enabled

boolean

Optional. Indicates whether the feature is currently enabled for this instance. This value can be modified via features.patch.

For features in the PUBLIC_PREVIEW stage, this field is automatically enabled if auto_enable_public_previews is set to true in FeatureSettings. However, a manual update to false will always take precedence, allowing customers to opt out of specific features even when automatic enablement (auto_enable_public_previews) is active.
stage

enum (FeatureStage)

Output only. The stage in which the feature flag is. Stage of the feature flag reflects the release stage it is in. eg. GA or Public Preview. This field is system-managed.
expectedRetirementDate

object (Date)

Output only. The expected date when this feature flag will be generally available to all customers.
category

enum (FeatureCategory)

Output only. The category or feature group this flag belongs to. This field reflects which team owns it.
prerequisiteFeatures[]

string

Output only. List of features that must be enabled before this feature can be enabled. Format: projects/{project}/locations/{location}/instances/{instance}/features/{feature}
dependentFeatures[]

string

Output only. List of features that depend on this feature. Format: projects/{project}/locations/{location}/instances/{instance}/features/{feature}

FeatureStage

Enum defining the state of the feature flag.

Enums
FEATURE_STAGE_UNSPECIFIED State is not specified.
FEATURE_STAGE_PUBLIC_PREVIEW The feature is available to be enabled.
FEATURE_STAGE_GENERAL_AVAILABILITY The feature is on by default for everyone and cannot be disabled.

FeatureCategory

Enum defining the category of the feature flag.

Enums
FEATURE_CATEGORY_UNSPECIFIED Add other categories as needed. Category is not specified.

Methods

disable

 Disables a specific Feature.

get

 Get a specific Feature.

list

 Lists all available Features for a given Chronicle instance.

patch

 Updates a specific Feature.