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 it can generally no longer be disabled. A small number of General Availability features remain customer-configurable; see the configurable field.

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
  ],
  "updateTime": string,
  "lastEditor": string,
  "configurable": boolean
}
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.
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}
updateTime

string (Timestamp format)

Output only. The time when the feature was last modified.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
lastEditor

string

Output only. The user who last edited the feature.
configurable

boolean

Output only. Whether enabled may be changed via features.patch for this instance.

Features in the PUBLIC_PREVIEW stage are always configurable. Features in the GENERAL_AVAILABILITY stage are configurable only when they have been designated as safe to turn off; otherwise features.patch returns FAILED_PRECONDITION. Clients should render non-configurable Features as read-only.

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. Most GA features cannot be disabled; those that remain customer-configurable are indicated by the configurable field.

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.