Class SettingSelector
java.lang.Object
com.azure.data.appconfiguration.models.SettingSelector
A set of options for selecting configuration settings from App Configuration service.
-
Providing
labelFilter
will filterConfigurationSettings
that match any label name in conjunction with the keys that are passed in to the service request. -
Providing
acceptDateTime
will return the representation of matchingConfigurationSetting
at that givenOffsetDateTime
. -
Providing
fields
will populate only thoseConfigurationSetting
fields in the response. By default, all of the fields are returned.
- See Also:
-
Constructor Summary
ConstructorDescriptionCreates a setting selector that will populate responses with all of theConfigurationSetting's
properties and select allkeys
. -
Method Summary
Modifier and TypeMethodDescriptionGets the date time for the request query.Gets the fields onConfigurationSetting
to return from the GET request.Gets the expressions to filterkeys
on for the request.Gets the labels used to filter settings based on theirlabel
in the service.setAcceptDatetime
(OffsetDateTime datetime) If set, then configuration setting values will be retrieved as they existed at the provided datetime.setFields
(SettingFields... fields) Sets fields that will be returned in the response corresponding to properties inConfigurationSetting
.setKeyFilter
(String keyFilter) Sets the expressions to filterkeys
on for the request.setLabelFilter
(String labelFilter) Sets the expression to filterlabels
on for the request.toString()
-
Constructor Details
-
SettingSelector
public SettingSelector()Creates a setting selector that will populate responses with all of theConfigurationSetting's
properties and select allkeys
.
-
-
Method Details
-
getKeyFilter
Gets the expressions to filterkeys
on for the request.See Filtering for more information about these supported filters.
- Returns:
- The expressions to filter ConfigurationSetting keys on.
-
setKeyFilter
Sets the expressions to filterkeys
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
-
getLabelFilter
Gets the labels used to filter settings based on theirlabel
in the service.See Filtering for more information about these supported filters.
- Returns:
- labels The labels used to filter GET requests from the service.
-
setLabelFilter
Sets the expression to filterlabels
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.
-
getAcceptDateTime
Gets the date time for the request query. When the query is performed, ifacceptDateTime
is set, theconfiguration setting value
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.
-
setAcceptDatetime
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 givenOffsetDateTime
.- Returns:
- The updated SettingSelector object.
-
getFields
Gets the fields onConfigurationSetting
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.
-
setFields
Sets fields that will be returned in the response corresponding to properties inConfigurationSetting
. 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.
-
toString
-