com.google.api.services.sheets.v4.model

Class FilterView

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.FilterView

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class FilterView
extends com.google.api.client.json.GenericJson

A filter view.

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>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
FilterView()

Method Summary

Modifier and Type	Method and Description
FilterView	clone()
Map<String,FilterCriteria>	getCriteria() The criteria for showing/hiding values per column.
List<FilterSpec>	getFilterSpecs() The filter criteria for showing/hiding values per column.
Integer	getFilterViewId() The ID of the filter view.
String	getNamedRangeId() The named range this filter view is backed by, if any.
GridRange	getRange() The range this filter view covers.
List<SortSpec>	getSortSpecs() The sort order per column.
String	getTitle() The name of the filter view.
FilterView	set(String fieldName, Object value)
FilterView	setCriteria(Map<String,FilterCriteria> criteria) The criteria for showing/hiding values per column.
FilterView	setFilterSpecs(List<FilterSpec> filterSpecs) The filter criteria for showing/hiding values per column.
FilterView	setFilterViewId(Integer filterViewId) The ID of the filter view.
FilterView	setNamedRangeId(String namedRangeId) The named range this filter view is backed by, if any.
FilterView	setRange(GridRange range) The range this filter view covers.
FilterView	setSortSpecs(List<SortSpec> sortSpecs) The sort order per column.
FilterView	setTitle(String title) The name of the filter view.

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

Constructor Detail

FilterView

public FilterView()

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 FilterView 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 for showing/hiding values 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 FilterView setFilterSpecs(List<FilterSpec> filterSpecs)

The filter criteria for showing/hiding values 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

getFilterViewId

public Integer getFilterViewId()

The ID of the filter view.

Returns:

value or null for none

setFilterViewId

public FilterView setFilterViewId(Integer filterViewId)

The ID of the filter view.

Parameters:

filterViewId - filterViewId or null for none

getNamedRangeId

public String getNamedRangeId()

The named range this filter view is backed by, if any. When writing, only one of range or named_range_id may be set.

Returns:

value or null for none

setNamedRangeId

public FilterView setNamedRangeId(String namedRangeId)

The named range this filter view is backed by, if any. When writing, only one of range or named_range_id may be set.

Parameters:

namedRangeId - namedRangeId or null for none

getRange

public GridRange getRange()

The range this filter view covers. When writing, only one of range or named_range_id may be set.

Returns:

value or null for none

setRange

public FilterView setRange(GridRange range)

The range this filter view covers. When writing, only one of range or named_range_id may be set.

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 FilterView 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

getTitle

public String getTitle()

The name of the filter view.

Returns:

value or null for none

setTitle

public FilterView setTitle(String title)

The name of the filter view.

Parameters:

title - title or null for none

set

public FilterView set(String fieldName,
                      Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public FilterView clone()

Overrides:

clone in class com.google.api.client.json.GenericJson