BatchGetValuesByDataFilterRequest (Google Sheets API v4 (Rev. 612) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.sheets.v4.model.BatchGetValuesByDataFilterRequest

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.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
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

BatchGetValuesByDataFilterRequest()

Constructors
Constructor and Description
`BatchGetValuesByDataFilterRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchGetValuesByDataFilterRequest`	`clone()`
`java.util.List<DataFilter>`	`getDataFilters()` The data filters used to match the ranges of values to retrieve.
`java.lang.String`	`getDateTimeRenderOption()` How dates, times, and durations should be represented in the output.
`java.lang.String`	`getMajorDimension()` The major dimension that results should use.
`java.lang.String`	`getValueRenderOption()` How values should be represented in the output.
`BatchGetValuesByDataFilterRequest`	`set(java.lang.String fieldName, java.lang.Object value)`
`BatchGetValuesByDataFilterRequest`	`setDataFilters(java.util.List<DataFilter> dataFilters)` The data filters used to match the ranges of values to retrieve.
`BatchGetValuesByDataFilterRequest`	`setDateTimeRenderOption(java.lang.String dateTimeRenderOption)` How dates, times, and durations should be represented in the output.
`BatchGetValuesByDataFilterRequest`	`setMajorDimension(java.lang.String majorDimension)` The major dimension that results should use.
`BatchGetValuesByDataFilterRequest`	`setValueRenderOption(java.lang.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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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 java.util.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(java.util.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 java.lang.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 [DateTimeRenderOption.SERIAL_NUMBER].
    
    Returns:
    
    value or null for none
  - setDateTimeRenderOption
```
public BatchGetValuesByDataFilterRequest setDateTimeRenderOption(java.lang.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 [DateTimeRenderOption.SERIAL_NUMBER].
    
    Parameters:
    
    dateTimeRenderOption - dateTimeRenderOption or null for none
  - getMajorDimension
```
public java.lang.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(java.lang.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 java.lang.String getValueRenderOption()
```
    How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
    
    Returns:
    
    value or null for none
  - setValueRenderOption
```
public BatchGetValuesByDataFilterRequest setValueRenderOption(java.lang.String valueRenderOption)
```
    How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
    
    Parameters:
    
    valueRenderOption - valueRenderOption or null for none
  - set
```
public BatchGetValuesByDataFilterRequest set(java.lang.String fieldName,
                                             java.lang.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

Google Sheets API v4 (revision 612)

Class BatchGetValuesByDataFilterRequest

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

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

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

BatchGetValuesByDataFilterRequest

Method Detail

getDataFilters

setDataFilters

getDateTimeRenderOption

setDateTimeRenderOption

getMajorDimension

setMajorDimension

getValueRenderOption

setValueRenderOption

set

clone