Sheets.Spreadsheets.GetByDataFilter (Google Sheets API v4-rev20250616-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.sheets.v4.SheetsRequest<Spreadsheet>
        
        com.google.api.services.sheets.v4.Sheets.Spreadsheets.GetByDataFilter

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Sheets.Spreadsheets
```
public class Sheets.Spreadsheets.GetByDataFilter
extends SheetsRequest<Spreadsheet>
```

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>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GetByDataFilter(String spreadsheetId, GetSpreadsheetByDataFilterRequest content)` Returns the spreadsheet at the given ID.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getSpreadsheetId()` The spreadsheet to request.
`Sheets.Spreadsheets.GetByDataFilter`	`set(String parameterName, Object value)`
`Sheets.Spreadsheets.GetByDataFilter`	`set$Xgafv(String $Xgafv)` V1 error format.
`Sheets.Spreadsheets.GetByDataFilter`	`setAccessToken(String accessToken)` OAuth access token.
`Sheets.Spreadsheets.GetByDataFilter`	`setAlt(String alt)` Data format for response.
`Sheets.Spreadsheets.GetByDataFilter`	`setCallback(String callback)` JSONP
`Sheets.Spreadsheets.GetByDataFilter`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Sheets.Spreadsheets.GetByDataFilter`	`setKey(String key)` API key.
`Sheets.Spreadsheets.GetByDataFilter`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Sheets.Spreadsheets.GetByDataFilter`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Sheets.Spreadsheets.GetByDataFilter`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Sheets.Spreadsheets.GetByDataFilter`	`setSpreadsheetId(String spreadsheetId)` The spreadsheet to request.
`Sheets.Spreadsheets.GetByDataFilter`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Sheets.Spreadsheets.GetByDataFilter`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.sheets.v4.SheetsRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

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
  - GetByDataFilter
```
protected GetByDataFilter(String spreadsheetId,
                          GetSpreadsheetByDataFilterRequest content)
```
    Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data one of 2 ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. Create a request for the method "spreadsheets.getByDataFilter". This request holds the parameters needed by the the sheets server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    GetByDataFilter#initialize(com.google.api.client.googleapis.services.AbstractGoogleC lientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    spreadsheetId - The spreadsheet to request.
    
    content - the GetSpreadsheetByDataFilterRequest
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public Sheets.Spreadsheets.GetByDataFilter set$Xgafv(String $Xgafv)
```
    Description copied from class: SheetsRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class SheetsRequest<Spreadsheet>
  - setAccessToken
```
public Sheets.Spreadsheets.GetByDataFilter setAccessToken(String accessToken)
```
    Description copied from class: SheetsRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class SheetsRequest<Spreadsheet>
  - setAlt
```
public Sheets.Spreadsheets.GetByDataFilter setAlt(String alt)
```
    Description copied from class: SheetsRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class SheetsRequest<Spreadsheet>
  - setCallback
```
public Sheets.Spreadsheets.GetByDataFilter setCallback(String callback)
```
    Description copied from class: SheetsRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class SheetsRequest<Spreadsheet>
  - setFields
```
public Sheets.Spreadsheets.GetByDataFilter setFields(String fields)
```
    Description copied from class: SheetsRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class SheetsRequest<Spreadsheet>
  - setKey
```
public Sheets.Spreadsheets.GetByDataFilter setKey(String key)
```
    Description copied from class: SheetsRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class SheetsRequest<Spreadsheet>
  - setOauthToken
```
public Sheets.Spreadsheets.GetByDataFilter setOauthToken(String oauthToken)
```
    Description copied from class: SheetsRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class SheetsRequest<Spreadsheet>
  - setPrettyPrint
```
public Sheets.Spreadsheets.GetByDataFilter setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: SheetsRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class SheetsRequest<Spreadsheet>
  - setQuotaUser
```
public Sheets.Spreadsheets.GetByDataFilter setQuotaUser(String quotaUser)
```
    Description copied from class: SheetsRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class SheetsRequest<Spreadsheet>
  - setUploadType
```
public Sheets.Spreadsheets.GetByDataFilter setUploadType(String uploadType)
```
    Description copied from class: SheetsRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class SheetsRequest<Spreadsheet>
  - setUploadProtocol
```
public Sheets.Spreadsheets.GetByDataFilter setUploadProtocol(String uploadProtocol)
```
    Description copied from class: SheetsRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class SheetsRequest<Spreadsheet>
  - getSpreadsheetId
```
public String getSpreadsheetId()
```
    The spreadsheet to request.
  - setSpreadsheetId
```
public Sheets.Spreadsheets.GetByDataFilter setSpreadsheetId(String spreadsheetId)
```
    The spreadsheet to request.
  - set
```
public Sheets.Spreadsheets.GetByDataFilter set(String parameterName,
                                               Object value)
```
    Overrides:
    
    set in class SheetsRequest<Spreadsheet>

Class Sheets.Spreadsheets.GetByDataFilter

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

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.sheets.v4.SheetsRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

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

GetByDataFilter

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getSpreadsheetId

setSpreadsheetId

set