com.google.api.services.sheets.v4

Class Sheets.Spreadsheets.Values.BatchGetByDataFilter

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

com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchGetByDataFilter

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Sheets.Spreadsheets.Values

public class Sheets.Spreadsheets.Values.BatchGetByDataFilter
extends SheetsRequest<BatchGetValuesByDataFilterResponse>

Nested Class Summary

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

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BatchGetByDataFilter(String spreadsheetId, BatchGetValuesByDataFilterRequest content) Returns one or more ranges of values that match the specified data filters.

Method Summary

Modifier and Type	Method and Description
String	getSpreadsheetId() The ID of the spreadsheet to retrieve data from.
Sheets.Spreadsheets.Values.BatchGetByDataFilter	set(String parameterName, Object value)
Sheets.Spreadsheets.Values.BatchGetByDataFilter	set$Xgafv(String $Xgafv) V1 error format.
Sheets.Spreadsheets.Values.BatchGetByDataFilter	setAccessToken(String accessToken) OAuth access token.
Sheets.Spreadsheets.Values.BatchGetByDataFilter	setAlt(String alt) Data format for response.
Sheets.Spreadsheets.Values.BatchGetByDataFilter	setCallback(String callback) JSONP
Sheets.Spreadsheets.Values.BatchGetByDataFilter	setFields(String fields) Selector specifying which fields to include in a partial response.
Sheets.Spreadsheets.Values.BatchGetByDataFilter	setKey(String key) API key.
Sheets.Spreadsheets.Values.BatchGetByDataFilter	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Sheets.Spreadsheets.Values.BatchGetByDataFilter	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Sheets.Spreadsheets.Values.BatchGetByDataFilter	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Sheets.Spreadsheets.Values.BatchGetByDataFilter	setSpreadsheetId(String spreadsheetId) The ID of the spreadsheet to retrieve data from.
Sheets.Spreadsheets.Values.BatchGetByDataFilter	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Sheets.Spreadsheets.Values.BatchGetByDataFilter	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

BatchGetByDataFilter

protected BatchGetByDataFilter(String spreadsheetId,
                               BatchGetValuesByDataFilterRequest content)

Returns one or more ranges of values that match the specified data filters. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned. Create a request for the method "values.batchGetByDataFilter". 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.

BatchGetByDataFilter#initialize(com.google.api.client.googleapis.services .AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

spreadsheetId - The ID of the spreadsheet to retrieve data from.

content - the BatchGetValuesByDataFilterRequest

Since:

1.13

Method Detail

set$Xgafv

public Sheets.Spreadsheets.Values.BatchGetByDataFilter set$Xgafv(String $Xgafv)

Description copied from class: SheetsRequest

V1 error format.

Overrides:

set$Xgafv in class SheetsRequest<BatchGetValuesByDataFilterResponse>

setAccessToken

public Sheets.Spreadsheets.Values.BatchGetByDataFilter setAccessToken(String accessToken)

Description copied from class: SheetsRequest

OAuth access token.

Overrides:

setAccessToken in class SheetsRequest<BatchGetValuesByDataFilterResponse>

setAlt

public Sheets.Spreadsheets.Values.BatchGetByDataFilter setAlt(String alt)

Description copied from class: SheetsRequest

Data format for response.

Overrides:

setAlt in class SheetsRequest<BatchGetValuesByDataFilterResponse>

setCallback

public Sheets.Spreadsheets.Values.BatchGetByDataFilter setCallback(String callback)

Description copied from class: SheetsRequest

JSONP

Overrides:

setCallback in class SheetsRequest<BatchGetValuesByDataFilterResponse>

setFields

public Sheets.Spreadsheets.Values.BatchGetByDataFilter setFields(String fields)

Description copied from class: SheetsRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class SheetsRequest<BatchGetValuesByDataFilterResponse>

setKey

public Sheets.Spreadsheets.Values.BatchGetByDataFilter 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<BatchGetValuesByDataFilterResponse>

setOauthToken

public Sheets.Spreadsheets.Values.BatchGetByDataFilter setOauthToken(String oauthToken)

Description copied from class: SheetsRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class SheetsRequest<BatchGetValuesByDataFilterResponse>

setPrettyPrint

public Sheets.Spreadsheets.Values.BatchGetByDataFilter setPrettyPrint(Boolean prettyPrint)

Description copied from class: SheetsRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class SheetsRequest<BatchGetValuesByDataFilterResponse>

setQuotaUser

public Sheets.Spreadsheets.Values.BatchGetByDataFilter 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<BatchGetValuesByDataFilterResponse>

setUploadType

public Sheets.Spreadsheets.Values.BatchGetByDataFilter setUploadType(String uploadType)

Description copied from class: SheetsRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class SheetsRequest<BatchGetValuesByDataFilterResponse>

setUploadProtocol

public Sheets.Spreadsheets.Values.BatchGetByDataFilter setUploadProtocol(String uploadProtocol)

Description copied from class: SheetsRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class SheetsRequest<BatchGetValuesByDataFilterResponse>

getSpreadsheetId

public String getSpreadsheetId()

The ID of the spreadsheet to retrieve data from.

setSpreadsheetId

public Sheets.Spreadsheets.Values.BatchGetByDataFilter setSpreadsheetId(String spreadsheetId)

The ID of the spreadsheet to retrieve data from.

set

public Sheets.Spreadsheets.Values.BatchGetByDataFilter set(String parameterName,
                                                           Object value)

Overrides:

set in class SheetsRequest<BatchGetValuesByDataFilterResponse>