target.apidocs.com.google.api.services.sheets.v4.model.BasicFilter.html Maven / Gradle / Ivy
BasicFilter (Google Sheets API v4-rev20240319-2.0.0)
com.google.api.services.sheets.v4.model
Class BasicFilter
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.sheets.v4.model.BasicFilter
-
public final class BasicFilter
extends com.google.api.client.json.GenericJson
The default filter associated with a sheet.
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Google Sheets API. For a detailed explanation see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
BasicFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
BasicFilter
clone()
Map<String,FilterCriteria>
getCriteria()
The criteria for showing/hiding values per column.
List<FilterSpec>
getFilterSpecs()
The filter criteria per column.
GridRange
getRange()
The range the filter covers.
List<SortSpec>
getSortSpecs()
The sort order per column.
BasicFilter
set(String fieldName,
Object value)
BasicFilter
setCriteria(Map<String,FilterCriteria> criteria)
The criteria for showing/hiding values per column.
BasicFilter
setFilterSpecs(List<FilterSpec> filterSpecs)
The filter criteria per column.
BasicFilter
setRange(GridRange range)
The range the filter covers.
BasicFilter
setSortSpecs(List<SortSpec> sortSpecs)
The sort order per column.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getCriteria
public Map<String,FilterCriteria> getCriteria()
The criteria for showing/hiding values per column. The map's key is the column index, and the
value is the criteria for that column. This field is deprecated in favor of filter_specs.
- Returns:
- value or
null
for none
-
setCriteria
public BasicFilter setCriteria(Map<String,FilterCriteria> criteria)
The criteria for showing/hiding values per column. The map's key is the column index, and the
value is the criteria for that column. This field is deprecated in favor of filter_specs.
- Parameters:
criteria
- criteria or null
for none
-
getFilterSpecs
public List<FilterSpec> getFilterSpecs()
The filter criteria per column. Both criteria and filter_specs are populated in responses. If
both fields are specified in an update request, this field takes precedence.
- Returns:
- value or
null
for none
-
setFilterSpecs
public BasicFilter setFilterSpecs(List<FilterSpec> filterSpecs)
The filter criteria per column. Both criteria and filter_specs are populated in responses. If
both fields are specified in an update request, this field takes precedence.
- Parameters:
filterSpecs
- filterSpecs or null
for none
-
getRange
public GridRange getRange()
The range the filter covers.
- Returns:
- value or
null
for none
-
setRange
public BasicFilter setRange(GridRange range)
The range the filter covers.
- Parameters:
range
- range or null
for none
-
getSortSpecs
public List<SortSpec> getSortSpecs()
The sort order per column. Later specifications are used when values are equal in the earlier
specifications.
- Returns:
- value or
null
for none
-
setSortSpecs
public BasicFilter setSortSpecs(List<SortSpec> sortSpecs)
The sort order per column. Later specifications are used when values are equal in the earlier
specifications.
- Parameters:
sortSpecs
- sortSpecs or null
for none
-
set
public BasicFilter set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public BasicFilter clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.