com.azure.data.appconfiguration.models.SettingSelector.yml

### YamlMime:JavaType
uid: "com.azure.data.appconfiguration.models.SettingSelector"
fullName: "com.azure.data.appconfiguration.models.SettingSelector"
name: "SettingSelector"
nameWithType: "SettingSelector"
summary: "A set of options for selecting configuration settings from App Configuration service."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **SettingSelector**"
constructors:
- uid: "com.azure.data.appconfiguration.models.SettingSelector.SettingSelector()"
  fullName: "com.azure.data.appconfiguration.models.SettingSelector.SettingSelector()"
  name: "SettingSelector()"
  nameWithType: "SettingSelector.SettingSelector()"
  summary: "Creates a setting selector that will populate responses with all of the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting's\"></xref> properties and select all <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getKey()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"keys\"></xref>."
  syntax: "public SettingSelector()"
  desc: "Creates a setting selector that will populate responses with all of the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting's\"></xref> properties and select all <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getKey()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"keys\"></xref>."
methods:
- uid: "com.azure.data.appconfiguration.models.SettingSelector.getAcceptDateTime()"
  fullName: "com.azure.data.appconfiguration.models.SettingSelector.getAcceptDateTime()"
  name: "getAcceptDateTime()"
  nameWithType: "SettingSelector.getAcceptDateTime()"
  summary: "Gets the date time for the request query."
  syntax: "public String getAcceptDateTime()"
  desc: "Gets the date time for the request query. When the query is performed, if `acceptDateTime` is set, the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getValue()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"configuration setting value\"></xref> at that point in time is returned. Otherwise, the current value is returned."
  returns:
    description: "Gets the currently set datetime in <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DateTimeFormatter#RFC_1123_DATE_TIME\"></xref> format."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.data.appconfiguration.models.SettingSelector.getFields()"
  fullName: "com.azure.data.appconfiguration.models.SettingSelector.getFields()"
  name: "getFields()"
  nameWithType: "SettingSelector.getFields()"
  summary: "Gets the fields on <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> to return from the GET request."
  syntax: "public SettingFields[] getFields()"
  desc: "Gets the fields on <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> to return from the GET request. If none are set, the service returns the ConfigurationSettings with all of their fields populated."
  returns:
    description: "The set of <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> fields to return for a GET request."
    type: "<xref href=\"com.azure.data.appconfiguration.models.SettingFields?alt=com.azure.data.appconfiguration.models.SettingFields&text=SettingFields\" data-throw-if-not-resolved=\"False\" />[]"
- uid: "com.azure.data.appconfiguration.models.SettingSelector.getKeyFilter()"
  fullName: "com.azure.data.appconfiguration.models.SettingSelector.getKeyFilter()"
  name: "getKeyFilter()"
  nameWithType: "SettingSelector.getKeyFilter()"
  summary: "Gets the expressions to filter <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getKey()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"keys\"></xref> on for the request."
  syntax: "public String getKeyFilter()"
  desc: "Gets the expressions to filter <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getKey()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"keys\"></xref> on for the request.\n\nSee [Filtering][] for more information about these supported filters.\n\n\n[Filtering]: https://docs.microsoft.com/azure/azure-app-configuration/rest-api-key-value#supported-filters"
  returns:
    description: "The expressions to filter ConfigurationSetting keys on."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.data.appconfiguration.models.SettingSelector.getLabelFilter()"
  fullName: "com.azure.data.appconfiguration.models.SettingSelector.getLabelFilter()"
  name: "getLabelFilter()"
  nameWithType: "SettingSelector.getLabelFilter()"
  summary: "Gets the labels used to filter settings based on their <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getLabel()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"label\"></xref> in the service."
  syntax: "public String getLabelFilter()"
  desc: "Gets the labels used to filter settings based on their <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getLabel()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"label\"></xref> in the service.\n\nSee [Filtering][] for more information about these supported filters.\n\n\n[Filtering]: https://docs.microsoft.com/azure/azure-app-configuration/rest-api-key-value#supported-filters"
  returns:
    description: "labels The labels used to filter GET requests from the service."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.data.appconfiguration.models.SettingSelector.getMatchConditions()"
  fullName: "com.azure.data.appconfiguration.models.SettingSelector.getMatchConditions()"
  name: "getMatchConditions()"
  nameWithType: "SettingSelector.getMatchConditions()"
  summary: "Get the match conditions"
  syntax: "public List<MatchConditions> getMatchConditions()"
  desc: "Get the match conditions"
  returns:
    description: "The match conditions"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.core.http.MatchConditions?alt=com.azure.core.http.MatchConditions&text=MatchConditions\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.data.appconfiguration.models.SettingSelector.setAcceptDatetime(java.time.OffsetDateTime)"
  fullName: "com.azure.data.appconfiguration.models.SettingSelector.setAcceptDatetime(OffsetDateTime datetime)"
  name: "setAcceptDatetime(OffsetDateTime datetime)"
  nameWithType: "SettingSelector.setAcceptDatetime(OffsetDateTime datetime)"
  summary: "If set, then configuration setting values will be retrieved as they existed at the provided datetime."
  parameters:
  - description: "The value of the configuration setting at that given <xref uid=\"java.time.OffsetDateTime\" data-throw-if-not-resolved=\"false\" data-raw-source=\"OffsetDateTime\"></xref>."
    name: "datetime"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
  syntax: "public SettingSelector setAcceptDatetime(OffsetDateTime datetime)"
  desc: "If set, then configuration setting values will be retrieved as they existed at the provided datetime. Otherwise, the current values are returned."
  returns:
    description: "The updated SettingSelector object."
    type: "<xref href=\"com.azure.data.appconfiguration.models.SettingSelector?alt=com.azure.data.appconfiguration.models.SettingSelector&text=SettingSelector\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.models.SettingSelector.setFields(com.azure.data.appconfiguration.models.SettingFields...)"
  fullName: "com.azure.data.appconfiguration.models.SettingSelector.setFields(SettingFields[] fields)"
  name: "setFields(SettingFields[] fields)"
  nameWithType: "SettingSelector.setFields(SettingFields[] fields)"
  summary: "Sets fields that will be returned in the response corresponding to properties in <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref>."
  parameters:
  - description: "The fields to select for the query response. If none are set, the service will return the\n ConfigurationSettings with a default set of properties."
    name: "fields"
    type: "<xref href=\"com.azure.data.appconfiguration.models.SettingFields?alt=com.azure.data.appconfiguration.models.SettingFields&text=SettingFields\" data-throw-if-not-resolved=\"False\" />[]"
  syntax: "public SettingSelector setFields(SettingFields[] fields)"
  desc: "Sets fields that will be returned in the response corresponding to properties in <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref>. If none are set, the service returns ConfigurationSettings with all of their fields populated."
  returns:
    description: "The updated SettingSelector object."
    type: "<xref href=\"com.azure.data.appconfiguration.models.SettingSelector?alt=com.azure.data.appconfiguration.models.SettingSelector&text=SettingSelector\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.models.SettingSelector.setKeyFilter(java.lang.String)"
  fullName: "com.azure.data.appconfiguration.models.SettingSelector.setKeyFilter(String keyFilter)"
  name: "setKeyFilter(String keyFilter)"
  nameWithType: "SettingSelector.setKeyFilter(String keyFilter)"
  summary: "Sets the expressions to filter <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getKey()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"keys\"></xref> on for the request."
  parameters:
  - description: "The expressions to filter ConfigurationSetting keys on."
    name: "keyFilter"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SettingSelector setKeyFilter(String keyFilter)"
  desc: "Sets the expressions to filter <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getKey()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"keys\"></xref> on for the request.\n\nSee [Filtering][] for more information about these supported filters.\n\n\n[Filtering]: https://docs.microsoft.com/azure/azure-app-configuration/rest-api-key-value#supported-filters"
  returns:
    description: "The updated SettingSelector object"
    type: "<xref href=\"com.azure.data.appconfiguration.models.SettingSelector?alt=com.azure.data.appconfiguration.models.SettingSelector&text=SettingSelector\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.models.SettingSelector.setLabelFilter(java.lang.String)"
  fullName: "com.azure.data.appconfiguration.models.SettingSelector.setLabelFilter(String labelFilter)"
  name: "setLabelFilter(String labelFilter)"
  nameWithType: "SettingSelector.setLabelFilter(String labelFilter)"
  summary: "Sets the expression to filter <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getLabel()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"labels\"></xref> on for the request."
  parameters:
  - description: "The expressions to filter ConfigurationSetting labels on."
    name: "labelFilter"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SettingSelector setLabelFilter(String labelFilter)"
  desc: "Sets the expression to filter <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getLabel()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"labels\"></xref> on for the request.\n\nSee [Filtering][] for more information about these supported filters.\n\n\n[Filtering]: https://docs.microsoft.com/azure/azure-app-configuration/rest-api-key-value#supported-filters"
  returns:
    description: "SettingSelector The updated SettingSelector object."
    type: "<xref href=\"com.azure.data.appconfiguration.models.SettingSelector?alt=com.azure.data.appconfiguration.models.SettingSelector&text=SettingSelector\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.models.SettingSelector.setMatchConditions(java.util.List<com.azure.core.http.MatchConditions>)"
  fullName: "com.azure.data.appconfiguration.models.SettingSelector.setMatchConditions(List<MatchConditions> matchConditions)"
  name: "setMatchConditions(List<MatchConditions> matchConditions)"
  nameWithType: "SettingSelector.setMatchConditions(List<MatchConditions> matchConditions)"
  summary: "Set the match conditions"
  parameters:
  - description: "The match conditions"
    name: "matchConditions"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.core.http.MatchConditions?alt=com.azure.core.http.MatchConditions&text=MatchConditions\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public SettingSelector setMatchConditions(List<MatchConditions> matchConditions)"
  desc: "Set the match conditions"
  returns:
    description: "The updated SettingSelector object."
    type: "<xref href=\"com.azure.data.appconfiguration.models.SettingSelector?alt=com.azure.data.appconfiguration.models.SettingSelector&text=SettingSelector\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.data.appconfiguration.models.SettingSelector.toString()"
  fullName: "com.azure.data.appconfiguration.models.SettingSelector.toString()"
  name: "toString()"
  nameWithType: "SettingSelector.toString()"
  overridden: "java.lang.Object.toString()"
  syntax: "public String toString()"
  returns:
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
type: "class"
desc: "A set of options for selecting configuration settings from App Configuration service.\n\n *  Providing <xref uid=\"com.azure.data.appconfiguration.models.SettingSelector.getLabelFilter()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"labelFilter\"></xref> will filter <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSettings\"></xref> that match any label name in conjunction with the keys that are passed in to the service request.\n *  Providing <xref uid=\"com.azure.data.appconfiguration.models.SettingSelector.getAcceptDateTime()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"acceptDateTime\"></xref> will return the representation of matching <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> at that given <xref uid=\"java.time.OffsetDateTime\" data-throw-if-not-resolved=\"false\" data-raw-source=\"OffsetDateTime\"></xref>.\n *  Providing <xref uid=\"com.azure.data.appconfiguration.models.SettingSelector.getFields()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"fields\"></xref> will populate only those <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> fields in the response. By default, all of the fields are returned."
metadata: {}
package: "com.azure.data.appconfiguration.models"
artifact: com.azure:azure-data-appconfiguration:1.6.1