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

Class BatchGetValuesByDataFilterRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

The request for retrieving a range of values in a spreadsheet selected by a set of DataFilters.

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
BatchGetValuesByDataFilterRequest()

Method Summary

Modifier and Type	Method and Description
BatchGetValuesByDataFilterRequest	clone()
List<DataFilter>	getDataFilters() The data filters used to match the ranges of values to retrieve.
String	getDateTimeRenderOption() How dates, times, and durations should be represented in the output.
String	getMajorDimension() The major dimension that results should use.
String	getValueRenderOption() How values should be represented in the output.
BatchGetValuesByDataFilterRequest	set(String fieldName, Object value)
BatchGetValuesByDataFilterRequest	setDataFilters(List<DataFilter> dataFilters) The data filters used to match the ranges of values to retrieve.
BatchGetValuesByDataFilterRequest	setDateTimeRenderOption(String dateTimeRenderOption) How dates, times, and durations should be represented in the output.
BatchGetValuesByDataFilterRequest	setMajorDimension(String majorDimension) The major dimension that results should use.
BatchGetValuesByDataFilterRequest	setValueRenderOption(String valueRenderOption) How values should be represented in the output.

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

BatchGetValuesByDataFilterRequest

public BatchGetValuesByDataFilterRequest()

Method Detail

getDataFilters

public List<DataFilter> getDataFilters()

The data filters used to match the ranges of values to retrieve. Ranges that match any of the specified data filters are included in the response.

Returns:

value or null for none

setDataFilters

public BatchGetValuesByDataFilterRequest setDataFilters(List<DataFilter> dataFilters)

The data filters used to match the ranges of values to retrieve. Ranges that match any of the specified data filters are included in the response.

Parameters:

dataFilters - dataFilters or null for none

getDateTimeRenderOption

public String getDateTimeRenderOption()

How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.

Returns:

value or null for none

setDateTimeRenderOption

public BatchGetValuesByDataFilterRequest setDateTimeRenderOption(String dateTimeRenderOption)

How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.

Parameters:

dateTimeRenderOption - dateTimeRenderOption or null for none

getMajorDimension

public String getMajorDimension()

The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then a request that selects that range and sets `majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas a request that sets `majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.

Returns:

value or null for none

setMajorDimension

public BatchGetValuesByDataFilterRequest setMajorDimension(String majorDimension)

The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then a request that selects that range and sets `majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas a request that sets `majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.

Parameters:

majorDimension - majorDimension or null for none

getValueRenderOption

public String getValueRenderOption()

How values should be represented in the output. The default render option is FORMATTED_VALUE.

Returns:

value or null for none

setValueRenderOption

public BatchGetValuesByDataFilterRequest setValueRenderOption(String valueRenderOption)

How values should be represented in the output. The default render option is FORMATTED_VALUE.

Parameters:

valueRenderOption - valueRenderOption or null for none

set

public BatchGetValuesByDataFilterRequest set(String fieldName,
                                             Object value)

Overrides:

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

clone

public BatchGetValuesByDataFilterRequest clone()

Overrides:

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