Package com.azure.data.appconfiguration.models

Class FeatureFlagConfigurationSetting

java.lang.Object

com.azure.data.appconfiguration.models.ConfigurationSetting

com.azure.data.appconfiguration.models.FeatureFlagConfigurationSetting

All Implemented Interfaces:

com.azure.json.JsonSerializable<ConfigurationSetting>

public final class FeatureFlagConfigurationSetting
extends ConfigurationSetting

FeatureFlagConfigurationSetting allows you to customize your own feature flags to dynamically administer a feature's lifecycle. Feature flags can be used to enable or disable features.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_PREFIX	A prefix is used to construct a feature flag configuration setting's key.

Fields inherited from class com.azure.data.appconfiguration.models.ConfigurationSetting

NO_LABEL

Constructor Summary

Constructors

Constructor	Description
FeatureFlagConfigurationSetting(String featureId, boolean isEnabled)	The constructor for a feature flag configuration setting.

Method Summary

Modifier and Type	Method	Description
FeatureFlagConfigurationSetting	addClientFilter(FeatureFlagFilter clientFilter)	Add a feature flag filter to this configuration setting.
List<FeatureFlagFilter>	getClientFilters()	Gets the feature flag filters of this configuration setting.
String	getDescription()	Get the description of this configuration setting.
String	getDisplayName()	Get the display name of this configuration setting.
String	getFeatureId()	Get the feature ID of this configuration setting.
String	getValue()	Gets the value of this configuration setting.
boolean	isEnabled()	Get the boolean indicator to show if the setting is turn on or off.
FeatureFlagConfigurationSetting	setClientFilters(List<FeatureFlagFilter> clientFilters)	Sets the feature flag filters of this configuration setting.
FeatureFlagConfigurationSetting	setContentType(String contentType)	Sets the content type.
FeatureFlagConfigurationSetting	setDescription(String description)	Set the description of this configuration setting.
FeatureFlagConfigurationSetting	setDisplayName(String displayName)	Set the display name of this configuration setting.
FeatureFlagConfigurationSetting	setEnabled(boolean isEnabled)	Set the boolean indicator to show if the setting is turn on or off.
FeatureFlagConfigurationSetting	setETag(String etag)	Sets the ETag for this configuration setting.
FeatureFlagConfigurationSetting	setFeatureId(String featureId)	Set the feature ID of this configuration setting.
FeatureFlagConfigurationSetting	setKey(String key)	Sets the key of this setting.
FeatureFlagConfigurationSetting	setLabel(String label)	Sets the label of this configuration setting.
FeatureFlagConfigurationSetting	setTags(Map<String,String> tags)	Sets the tags for this configuration setting.
FeatureFlagConfigurationSetting	setValue(String value)	Sets the value of this setting.

Methods inherited from class com.azure.data.appconfiguration.models.ConfigurationSetting

fromJson, getContentType, getETag, getKey, getLabel, getLastModified, getTags, isReadOnly, toJson, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

KEY_PREFIX

public static final String KEY_PREFIX

A prefix is used to construct a feature flag configuration setting's key.

See Also:

• Constant Field Values

Constructor Details

FeatureFlagConfigurationSetting

public FeatureFlagConfigurationSetting(String featureId,
 boolean isEnabled)

The constructor for a feature flag configuration setting.

Parameters:

featureId - A feature flag identification value that used to construct in setting's key. The key of setting is KEY_PREFIX concatenate featureId.

isEnabled - A boolean value to turn on/off the feature flag setting.

Method Details

getValue

public String getValue()

Description copied from class: ConfigurationSetting

Gets the value of this configuration setting.

Overrides:

getValue in class ConfigurationSetting

Returns:

The value of this configuration setting.

setKey

public FeatureFlagConfigurationSetting setKey(String key)

Sets the key of this setting.

Overrides:

setKey in class ConfigurationSetting

Parameters:

key - The key to associate with this configuration setting.

Returns:

The updated FeatureFlagConfigurationSetting object.

setValue

public FeatureFlagConfigurationSetting setValue(String value)

Sets the value of this setting.

Overrides:

setValue in class ConfigurationSetting

Parameters:

value - The value to associate with this configuration setting.

Returns:

The updated FeatureFlagConfigurationSetting object.

Throws:

IllegalArgumentException - if the setting's value is an invalid JSON format.

setLabel

public FeatureFlagConfigurationSetting setLabel(String label)

Sets the label of this configuration setting. ConfigurationSetting.NO_LABEL is the default label used when this value is not set.

Overrides:

setLabel in class ConfigurationSetting

Parameters:

label - The label of this configuration setting.

Returns:

The updated FeatureFlagConfigurationSetting object.

setContentType

public FeatureFlagConfigurationSetting setContentType(String contentType)

Sets the content type. By default, the content type is null.

Overrides:

setContentType in class ConfigurationSetting

Parameters:

contentType - The content type of this configuration setting.

Returns:

The updated FeatureFlagConfigurationSetting object.

setETag

public FeatureFlagConfigurationSetting setETag(String etag)

Sets the ETag for this configuration setting.

Overrides:

setETag in class ConfigurationSetting

Parameters:

etag - The ETag for the configuration setting.

Returns:

The updated FeatureFlagConfigurationSetting object.

setTags

public FeatureFlagConfigurationSetting setTags(Map<String,String> tags)

Sets the tags for this configuration setting.

Overrides:

setTags in class ConfigurationSetting

Parameters:

tags - The tags to add to this configuration setting.

Returns:

The updated FeatureFlagConfigurationSetting object.

getFeatureId

public String getFeatureId()

Get the feature ID of this configuration setting.

Returns:

the feature ID of this configuration setting.

Throws:

IllegalArgumentException - if the setting's value is an invalid JSON format.

setFeatureId

public FeatureFlagConfigurationSetting setFeatureId(String featureId)

Set the feature ID of this configuration setting.

Parameters:

featureId - the feature ID of this configuration setting.

Returns:

The updated FeatureFlagConfigurationSetting object.

Throws:

IllegalArgumentException - if the setting's value is an invalid JSON format.

isEnabled

public boolean isEnabled()

Get the boolean indicator to show if the setting is turn on or off.

Returns:

the boolean indicator to show if the setting is turn on or off.

Throws:

IllegalArgumentException - if the setting's value is an invalid JSON format.

setEnabled

public FeatureFlagConfigurationSetting setEnabled(boolean isEnabled)

Set the boolean indicator to show if the setting is turn on or off.

Parameters:

isEnabled - the boolean indicator to show if the setting is turn on or off.

Returns:

The updated FeatureFlagConfigurationSetting object.

Throws:

IllegalArgumentException - if the setting's value is an invalid JSON format.

getDescription

public String getDescription()

Get the description of this configuration setting.

Returns:

the description of this configuration setting.

Throws:

IllegalArgumentException - if the setting's value is an invalid JSON format.

setDescription

public FeatureFlagConfigurationSetting setDescription(String description)

Set the description of this configuration setting.

Parameters:

description - the description of this configuration setting.

Returns:

The updated FeatureFlagConfigurationSetting object.

Throws:

IllegalArgumentException - if the setting's value is an invalid JSON format.

getDisplayName

public String getDisplayName()

Get the display name of this configuration setting.

Returns:

the display name of this configuration setting.

Throws:

IllegalArgumentException - if the setting's value is an invalid JSON format.

setDisplayName

public FeatureFlagConfigurationSetting setDisplayName(String displayName)

Set the display name of this configuration setting.

Parameters:

displayName - the display name of this configuration setting.

Returns:

The updated FeatureFlagConfigurationSetting object.

Throws:

IllegalArgumentException - if the setting's value is an invalid JSON format.

getClientFilters

public List<FeatureFlagFilter> getClientFilters()

Gets the feature flag filters of this configuration setting.

Returns:

the feature flag filters of this configuration setting.

Throws:

IllegalArgumentException - if the setting's value is an invalid JSON format.

setClientFilters

public FeatureFlagConfigurationSetting setClientFilters(List<FeatureFlagFilter> clientFilters)

Sets the feature flag filters of this configuration setting.

Parameters:

clientFilters - the feature flag filters of this configuration setting.

Returns:

The updated FeatureFlagConfigurationSetting object.

Throws:

IllegalArgumentException - if the setting's value is an invalid JSON format.

addClientFilter

public FeatureFlagConfigurationSetting addClientFilter(FeatureFlagFilter clientFilter)

Add a feature flag filter to this configuration setting.

Parameters:

clientFilter - a feature flag filter to add to this configuration setting.

Returns:

The updated FeatureFlagConfigurationSetting object.

Throws:

IllegalArgumentException - if the setting's value is an invalid JSON format.