com.google.api.services.sheets.v4.model

Class BatchUpdateSpreadsheetRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class BatchUpdateSpreadsheetRequest
extends GenericJson

The request for updating any aspect of a spreadsheet.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Sheets API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>

Constructor Summary

Constructors

Constructor and Description
BatchUpdateSpreadsheetRequest()

Method Summary

Modifier and Type	Method and Description
BatchUpdateSpreadsheetRequest	clone()
Boolean	getIncludeSpreadsheetInResponse() Determines if the update response should include the spreadsheet resource.
List<Request>	getRequests() A list of updates to apply to the spreadsheet.
Boolean	getResponseIncludeGridData() True if grid data should be returned.
List<String>	getResponseRanges() Limits the ranges included in the response spreadsheet.
BatchUpdateSpreadsheetRequest	set(String fieldName, Object value)
BatchUpdateSpreadsheetRequest	setIncludeSpreadsheetInResponse(Boolean includeSpreadsheetInResponse) Determines if the update response should include the spreadsheet resource.
BatchUpdateSpreadsheetRequest	setRequests(List<Request> requests) A list of updates to apply to the spreadsheet.
BatchUpdateSpreadsheetRequest	setResponseIncludeGridData(Boolean responseIncludeGridData) True if grid data should be returned.
BatchUpdateSpreadsheetRequest	setResponseRanges(List<String> responseRanges) Limits the ranges included in the response spreadsheet.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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

BatchUpdateSpreadsheetRequest

public BatchUpdateSpreadsheetRequest()

Method Detail

getIncludeSpreadsheetInResponse

public Boolean getIncludeSpreadsheetInResponse()

Determines if the update response should include the spreadsheet resource.

Returns:

value or null for none

setIncludeSpreadsheetInResponse

public BatchUpdateSpreadsheetRequest setIncludeSpreadsheetInResponse(Boolean includeSpreadsheetInResponse)

Determines if the update response should include the spreadsheet resource.

Parameters:

includeSpreadsheetInResponse - includeSpreadsheetInResponse or null for none

getRequests

public List<Request> getRequests()

A list of updates to apply to the spreadsheet. Requests will be applied in the order they are specified. If any request is not valid, no requests will be applied.

Returns:

value or null for none

setRequests

public BatchUpdateSpreadsheetRequest setRequests(List<Request> requests)

A list of updates to apply to the spreadsheet. Requests will be applied in the order they are specified. If any request is not valid, no requests will be applied.

Parameters:

requests - requests or null for none

getResponseIncludeGridData

public Boolean getResponseIncludeGridData()

True if grid data should be returned. Meaningful only if include_spreadsheet_in_response is 'true'. This parameter is ignored if a field mask was set in the request.

Returns:

value or null for none

setResponseIncludeGridData

public BatchUpdateSpreadsheetRequest setResponseIncludeGridData(Boolean responseIncludeGridData)

True if grid data should be returned. Meaningful only if include_spreadsheet_in_response is 'true'. This parameter is ignored if a field mask was set in the request.

Parameters:

responseIncludeGridData - responseIncludeGridData or null for none

getResponseRanges

public List<String> getResponseRanges()

Limits the ranges included in the response spreadsheet. Meaningful only if include_spreadsheet_in_response is 'true'.

Returns:

value or null for none

setResponseRanges

public BatchUpdateSpreadsheetRequest setResponseRanges(List<String> responseRanges)

Limits the ranges included in the response spreadsheet. Meaningful only if include_spreadsheet_in_response is 'true'.

Parameters:

responseRanges - responseRanges or null for none

set

public BatchUpdateSpreadsheetRequest set(String fieldName,
                                         Object value)

Overrides:

set in class GenericJson

clone

public BatchUpdateSpreadsheetRequest clone()

Overrides:

clone in class GenericJson