Docs.Documents.BatchUpdate (Google Docs API v1-rev20250325-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.docs.v1.DocsRequest<BatchUpdateDocumentResponse>
        
        com.google.api.services.docs.v1.Docs.Documents.BatchUpdate

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

Enclosing class:: Docs.Documents

public class Docs.Documents.BatchUpdate
extends DocsRequest<BatchUpdateDocumentResponse>

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 documentId, BatchUpdateDocumentRequest content)
Applies one or more updates to the document.

Constructors
Modifier	Constructor and Description
`protected`	`BatchUpdate(String documentId, BatchUpdateDocumentRequest content)` Applies one or more updates to the document.

Method Summary

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

Methods inherited from class com.google.api.services.docs.v1.DocsRequest
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 documentId,
                      BatchUpdateDocumentRequest content)
```
    Applies one or more updates to the document. 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. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies, the reply to the third request, and another empty reply, in that order. Because other users may be editing the document, the document might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the document should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically. Create a request for the method "documents.batchUpdate". This request holds the parameters needed by the the docs server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Docs.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    documentId - The ID of the document to update.
    
    content - the BatchUpdateDocumentRequest
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public Docs.Documents.BatchUpdate set$Xgafv(String $Xgafv)
```
    Description copied from class: DocsRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class DocsRequest<BatchUpdateDocumentResponse>
  - setAccessToken
```
public Docs.Documents.BatchUpdate setAccessToken(String accessToken)
```
    Description copied from class: DocsRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class DocsRequest<BatchUpdateDocumentResponse>
  - setAlt
```
public Docs.Documents.BatchUpdate setAlt(String alt)
```
    Description copied from class: DocsRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class DocsRequest<BatchUpdateDocumentResponse>
  - setCallback
```
public Docs.Documents.BatchUpdate setCallback(String callback)
```
    Description copied from class: DocsRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class DocsRequest<BatchUpdateDocumentResponse>
  - setFields
```
public Docs.Documents.BatchUpdate setFields(String fields)
```
    Description copied from class: DocsRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DocsRequest<BatchUpdateDocumentResponse>
  - setKey
```
public Docs.Documents.BatchUpdate setKey(String key)
```
    Description copied from class: DocsRequest
    
    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 DocsRequest<BatchUpdateDocumentResponse>
  - setOauthToken
```
public Docs.Documents.BatchUpdate setOauthToken(String oauthToken)
```
    Description copied from class: DocsRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DocsRequest<BatchUpdateDocumentResponse>
  - setPrettyPrint
```
public Docs.Documents.BatchUpdate setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: DocsRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DocsRequest<BatchUpdateDocumentResponse>
  - setQuotaUser
```
public Docs.Documents.BatchUpdate setQuotaUser(String quotaUser)
```
    Description copied from class: DocsRequest
    
    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 DocsRequest<BatchUpdateDocumentResponse>
  - setUploadType
```
public Docs.Documents.BatchUpdate setUploadType(String uploadType)
```
    Description copied from class: DocsRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class DocsRequest<BatchUpdateDocumentResponse>
  - setUploadProtocol
```
public Docs.Documents.BatchUpdate setUploadProtocol(String uploadProtocol)
```
    Description copied from class: DocsRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class DocsRequest<BatchUpdateDocumentResponse>
  - getDocumentId
```
public String getDocumentId()
```
    The ID of the document to update.
  - setDocumentId
```
public Docs.Documents.BatchUpdate setDocumentId(String documentId)
```
    The ID of the document to update.
  - set
```
public Docs.Documents.BatchUpdate set(String parameterName,
                                      Object value)
```
    Overrides:
    
    set in class DocsRequest<BatchUpdateDocumentResponse>

Class Docs.Documents.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.docs.v1.DocsRequest

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

getDocumentId

setDocumentId

set