com.google.api.services.sheets.v4

Class Sheets.Spreadsheets.Values.BatchClearByDataFilter

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Sheets.Spreadsheets.Values

public class Sheets.Spreadsheets.Values.BatchClearByDataFilter
extends SheetsRequest<BatchClearValuesByDataFilterResponse>

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	BatchClearByDataFilter(String spreadsheetId, BatchClearValuesByDataFilterRequest content) Clears one or more ranges of values from a spreadsheet.

Method Summary

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

BatchClearByDataFilter

protected BatchClearByDataFilter(String spreadsheetId,
                                 BatchClearValuesByDataFilterRequest content)

Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept. Create a request for the method "values.batchClearByDataFilter". 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.

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

Parameters:

spreadsheetId - The ID of the spreadsheet to update.

content - the BatchClearValuesByDataFilterRequest

Since:

1.13

Method Detail

set$Xgafv

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

Description copied from class: SheetsRequest

V1 error format.

Overrides:

set$Xgafv in class SheetsRequest<BatchClearValuesByDataFilterResponse>

setAccessToken

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

Description copied from class: SheetsRequest

OAuth access token.

Overrides:

setAccessToken in class SheetsRequest<BatchClearValuesByDataFilterResponse>

setAlt

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

Description copied from class: SheetsRequest

Data format for response.

Overrides:

setAlt in class SheetsRequest<BatchClearValuesByDataFilterResponse>

setCallback

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

Description copied from class: SheetsRequest

JSONP

Overrides:

setCallback in class SheetsRequest<BatchClearValuesByDataFilterResponse>

setFields

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

Description copied from class: SheetsRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class SheetsRequest<BatchClearValuesByDataFilterResponse>

setKey

public Sheets.Spreadsheets.Values.BatchClearByDataFilter 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<BatchClearValuesByDataFilterResponse>

setOauthToken

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

Description copied from class: SheetsRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class SheetsRequest<BatchClearValuesByDataFilterResponse>

setPrettyPrint

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

Description copied from class: SheetsRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class SheetsRequest<BatchClearValuesByDataFilterResponse>

setQuotaUser

public Sheets.Spreadsheets.Values.BatchClearByDataFilter 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<BatchClearValuesByDataFilterResponse>

setUploadType

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

Description copied from class: SheetsRequest

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

Overrides:

setUploadType in class SheetsRequest<BatchClearValuesByDataFilterResponse>

setUploadProtocol

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

Description copied from class: SheetsRequest

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

Overrides:

setUploadProtocol in class SheetsRequest<BatchClearValuesByDataFilterResponse>

getSpreadsheetId

public String getSpreadsheetId()

The ID of the spreadsheet to update.

setSpreadsheetId

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

The ID of the spreadsheet to update.

set

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

Overrides:

set in class SheetsRequest<BatchClearValuesByDataFilterResponse>