SettingSelector Class

Package:

com.azure.data.appconfiguration.models

Maven Artifact:

com.azure:azure-data-appconfiguration:1.6.0

• java.lang.Object
• • com.azure.data.appconfiguration.models.SettingSelector

public class SettingSelector

A set of options for selecting configuration settings from App Configuration service.

• Providing getLabelFilter() will filter ConfigurationSetting that match any label name in conjunction with the keys that are passed in to the service request.
• Providing getAcceptDateTime() will return the representation of matching ConfigurationSetting at that given OffsetDateTime.
• Providing getFields() will populate only those ConfigurationSetting fields in the response. By default, all of the fields are returned.

Constructor Summary

Constructor	Description
SettingSelector()	Creates a setting selector that will populate responses with all of the ConfigurationSetting properties and select all getKey().

Method Summary

Modifier and Type	Method and Description
String	getAcceptDateTime() Gets the date time for the request query.
SettingFields[]	getFields() Gets the fields on ConfigurationSetting to return from the GET request.
String	getKeyFilter() Gets the expressions to filter getKey() on for the request.
String	getLabelFilter() Gets the labels used to filter settings based on their getLabel() in the service.
List<MatchConditions>	getMatchConditions() Get the match conditions
SettingSelector	setAcceptDatetime(OffsetDateTime datetime) If set, then configuration setting values will be retrieved as they existed at the provided datetime.
SettingSelector	setFields(SettingFields[] fields) Sets fields that will be returned in the response corresponding to properties in ConfigurationSetting.
SettingSelector	setKeyFilter(String keyFilter) Sets the expressions to filter getKey() on for the request.
SettingSelector	setLabelFilter(String labelFilter) Sets the expression to filter getLabel() on for the request.
SettingSelector	setMatchConditions(List<MatchConditions> matchConditions) Set the match conditions
String	toString()

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SettingSelector

public SettingSelector()

Creates a setting selector that will populate responses with all of the ConfigurationSetting properties and select all getKey().

Method Details

getAcceptDateTime

public String getAcceptDateTime()

Gets the date time for the request query. When the query is performed, if acceptDateTime is set, the getValue() at that point in time is returned. Otherwise, the current value is returned.

Returns:

Gets the currently set datetime in DateTimeFormatter#RFC_1123_DATE_TIME format.

getFields

public SettingFields[] getFields()

Gets the fields on ConfigurationSetting to return from the GET request. If none are set, the service returns the ConfigurationSettings with all of their fields populated.

Returns:

The set of ConfigurationSetting fields to return for a GET request.

getKeyFilter

public String getKeyFilter()

Gets the expressions to filter getKey() on for the request.

See Filtering for more information about these supported filters.

Returns:

The expressions to filter ConfigurationSetting keys on.

getLabelFilter

public String getLabelFilter()

Gets the labels used to filter settings based on their getLabel() in the service.

See Filtering for more information about these supported filters.

Returns:

labels The labels used to filter GET requests from the service.

getMatchConditions

public List getMatchConditions()

Get the match conditions

Returns:

The match conditions

setAcceptDatetime

public SettingSelector setAcceptDatetime(OffsetDateTime datetime)

If set, then configuration setting values will be retrieved as they existed at the provided datetime. Otherwise, the current values are returned.

Parameters:

datetime - The value of the configuration setting at that given OffsetDateTime.

Returns:

The updated SettingSelector object.

setFields

public SettingSelector setFields(SettingFields[] fields)

Sets fields that will be returned in the response corresponding to properties in ConfigurationSetting. If none are set, the service returns ConfigurationSettings with all of their fields populated.

Parameters:

fields - The fields to select for the query response. If none are set, the service will return the ConfigurationSettings with a default set of properties.

Returns:

The updated SettingSelector object.

setKeyFilter

public SettingSelector setKeyFilter(String keyFilter)

Sets the expressions to filter getKey() on for the request.

See Filtering for more information about these supported filters.

Parameters:

keyFilter - The expressions to filter ConfigurationSetting keys on.

Returns:

The updated SettingSelector object

setLabelFilter

public SettingSelector setLabelFilter(String labelFilter)

Sets the expression to filter getLabel() on for the request.

See Filtering for more information about these supported filters.

Parameters:

labelFilter - The expressions to filter ConfigurationSetting labels on.

Returns:

SettingSelector The updated SettingSelector object.

setMatchConditions

public SettingSelector setMatchConditions(List matchConditions)

Set the match conditions

Parameters:

matchConditions - The match conditions

Returns:

The updated SettingSelector object.

toString

public String toString()

Overrides:

SettingSelector.toString()