Sheets.Spreadsheets.BatchUpdate (Google Sheets API v4-rev20241008-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<BatchUpdateSpreadsheetResponse>
        
        com.google.api.services.sheets.v4.Sheets.Spreadsheets.BatchUpdate

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: Sheets.Spreadsheets

public class Sheets.Spreadsheets.BatchUpdate
extends SheetsRequest<BatchUpdateSpreadsheetResponse>

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`	`BatchUpdate(String spreadsheetId, BatchUpdateSpreadsheetRequest content)` Applies one or more updates to the spreadsheet.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getSpreadsheetId()` The spreadsheet to apply the updates to.
`Sheets.Spreadsheets.BatchUpdate`	`set(String parameterName, Object value)`
`Sheets.Spreadsheets.BatchUpdate`	`set$Xgafv(String $Xgafv)` V1 error format.
`Sheets.Spreadsheets.BatchUpdate`	`setAccessToken(String accessToken)` OAuth access token.
`Sheets.Spreadsheets.BatchUpdate`	`setAlt(String alt)` Data format for response.
`Sheets.Spreadsheets.BatchUpdate`	`setCallback(String callback)` JSONP
`Sheets.Spreadsheets.BatchUpdate`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Sheets.Spreadsheets.BatchUpdate`	`setKey(String key)` API key.
`Sheets.Spreadsheets.BatchUpdate`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Sheets.Spreadsheets.BatchUpdate`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Sheets.Spreadsheets.BatchUpdate`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Sheets.Spreadsheets.BatchUpdate`	`setSpreadsheetId(String spreadsheetId)` The spreadsheet to apply the updates to.
`Sheets.Spreadsheets.BatchUpdate`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Sheets.Spreadsheets.BatchUpdate`	`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
  - BatchUpdate
```
protected BatchUpdate(String spreadsheetId,
                      BatchUpdateSpreadsheetRequest content)
```
    Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes. Create a request for the method "spreadsheets.batchUpdate". 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.
    Sheets.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    spreadsheetId - The spreadsheet to apply the updates to.
    
    content - the BatchUpdateSpreadsheetRequest
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public Sheets.Spreadsheets.BatchUpdate set$Xgafv(String $Xgafv)
```
    Description copied from class: SheetsRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class SheetsRequest<BatchUpdateSpreadsheetResponse>
  - setAccessToken
```
public Sheets.Spreadsheets.BatchUpdate setAccessToken(String accessToken)
```
    Description copied from class: SheetsRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class SheetsRequest<BatchUpdateSpreadsheetResponse>
  - setAlt
```
public Sheets.Spreadsheets.BatchUpdate setAlt(String alt)
```
    Description copied from class: SheetsRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class SheetsRequest<BatchUpdateSpreadsheetResponse>
  - setCallback
```
public Sheets.Spreadsheets.BatchUpdate setCallback(String callback)
```
    Description copied from class: SheetsRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class SheetsRequest<BatchUpdateSpreadsheetResponse>
  - setFields
```
public Sheets.Spreadsheets.BatchUpdate setFields(String fields)
```
    Description copied from class: SheetsRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class SheetsRequest<BatchUpdateSpreadsheetResponse>
  - setKey
```
public Sheets.Spreadsheets.BatchUpdate 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<BatchUpdateSpreadsheetResponse>
  - setOauthToken
```
public Sheets.Spreadsheets.BatchUpdate setOauthToken(String oauthToken)
```
    Description copied from class: SheetsRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class SheetsRequest<BatchUpdateSpreadsheetResponse>
  - setPrettyPrint
```
public Sheets.Spreadsheets.BatchUpdate setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: SheetsRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class SheetsRequest<BatchUpdateSpreadsheetResponse>
  - setQuotaUser
```
public Sheets.Spreadsheets.BatchUpdate 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<BatchUpdateSpreadsheetResponse>
  - setUploadType
```
public Sheets.Spreadsheets.BatchUpdate setUploadType(String uploadType)
```
    Description copied from class: SheetsRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class SheetsRequest<BatchUpdateSpreadsheetResponse>
  - setUploadProtocol
```
public Sheets.Spreadsheets.BatchUpdate setUploadProtocol(String uploadProtocol)
```
    Description copied from class: SheetsRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class SheetsRequest<BatchUpdateSpreadsheetResponse>
  - getSpreadsheetId
```
public String getSpreadsheetId()
```
    The spreadsheet to apply the updates to.
  - setSpreadsheetId
```
public Sheets.Spreadsheets.BatchUpdate setSpreadsheetId(String spreadsheetId)
```
    The spreadsheet to apply the updates to.
  - set
```
public Sheets.Spreadsheets.BatchUpdate set(String parameterName,
                                           Object value)
```
    Overrides:
    
    set in class SheetsRequest<BatchUpdateSpreadsheetResponse>

Class Sheets.Spreadsheets.BatchUpdate

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

BatchUpdate

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getSpreadsheetId

setSpreadsheetId

set