com.google.api.services.sheets.v4

Class Sheets.Spreadsheets.Values.Update

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Sheets.Spreadsheets.Values

public class Sheets.Spreadsheets.Values.Update
extends SheetsRequest<UpdateValuesResponse>

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	Update(String spreadsheetId, String range, ValueRange content) Sets values in a range of a spreadsheet.

Method Summary

Modifier and Type	Method and Description
Boolean	getIncludeValuesInResponse() Determines if the update response should include the values of the cells that were updated.
String	getRange() The [A1 notation](/sheets/api/guides/concepts#cell) of the values to update.
String	getResponseDateTimeRenderOption() Determines how dates, times, and durations in the response should be rendered.
String	getResponseValueRenderOption() Determines how values in the response should be rendered.
String	getSpreadsheetId() The ID of the spreadsheet to update.
String	getValueInputOption() How the input data should be interpreted.
Sheets.Spreadsheets.Values.Update	set(String parameterName, Object value)
Sheets.Spreadsheets.Values.Update	set$Xgafv(String $Xgafv) V1 error format.
Sheets.Spreadsheets.Values.Update	setAccessToken(String accessToken) OAuth access token.
Sheets.Spreadsheets.Values.Update	setAlt(String alt) Data format for response.
Sheets.Spreadsheets.Values.Update	setCallback(String callback) JSONP
Sheets.Spreadsheets.Values.Update	setFields(String fields) Selector specifying which fields to include in a partial response.
Sheets.Spreadsheets.Values.Update	setIncludeValuesInResponse(Boolean includeValuesInResponse) Determines if the update response should include the values of the cells that were updated.
Sheets.Spreadsheets.Values.Update	setKey(String key) API key.
Sheets.Spreadsheets.Values.Update	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Sheets.Spreadsheets.Values.Update	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Sheets.Spreadsheets.Values.Update	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Sheets.Spreadsheets.Values.Update	setRange(String range) The [A1 notation](/sheets/api/guides/concepts#cell) of the values to update.
Sheets.Spreadsheets.Values.Update	setResponseDateTimeRenderOption(String responseDateTimeRenderOption) Determines how dates, times, and durations in the response should be rendered.
Sheets.Spreadsheets.Values.Update	setResponseValueRenderOption(String responseValueRenderOption) Determines how values in the response should be rendered.
Sheets.Spreadsheets.Values.Update	setSpreadsheetId(String spreadsheetId) The ID of the spreadsheet to update.
Sheets.Spreadsheets.Values.Update	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Sheets.Spreadsheets.Values.Update	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Sheets.Spreadsheets.Values.Update	setValueInputOption(String valueInputOption) How the input data should be interpreted.

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

Update

protected Update(String spreadsheetId,
                 String range,
                 ValueRange content)

Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption. Create a request for the method "values.update". 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 ID of the spreadsheet to update.

range - The [A1 notation](/sheets/api/guides/concepts#cell) of the values to update.

content - the ValueRange

Since:

1.13

Method Detail

set$Xgafv

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

Description copied from class: SheetsRequest

V1 error format.

Overrides:

set$Xgafv in class SheetsRequest<UpdateValuesResponse>

setAccessToken

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

Description copied from class: SheetsRequest

OAuth access token.

Overrides:

setAccessToken in class SheetsRequest<UpdateValuesResponse>

setAlt

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

Description copied from class: SheetsRequest

Data format for response.

Overrides:

setAlt in class SheetsRequest<UpdateValuesResponse>

setCallback

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

Description copied from class: SheetsRequest

JSONP

Overrides:

setCallback in class SheetsRequest<UpdateValuesResponse>

setFields

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

Description copied from class: SheetsRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class SheetsRequest<UpdateValuesResponse>

setKey

public Sheets.Spreadsheets.Values.Update 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<UpdateValuesResponse>

setOauthToken

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

Description copied from class: SheetsRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class SheetsRequest<UpdateValuesResponse>

setPrettyPrint

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

Description copied from class: SheetsRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class SheetsRequest<UpdateValuesResponse>

setQuotaUser

public Sheets.Spreadsheets.Values.Update 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<UpdateValuesResponse>

setUploadType

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

Description copied from class: SheetsRequest

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

Overrides:

setUploadType in class SheetsRequest<UpdateValuesResponse>

setUploadProtocol

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

Description copied from class: SheetsRequest

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

Overrides:

setUploadProtocol in class SheetsRequest<UpdateValuesResponse>

getSpreadsheetId

public String getSpreadsheetId()

The ID of the spreadsheet to update.

setSpreadsheetId

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

The ID of the spreadsheet to update.

getRange

public String getRange()

The [A1 notation](/sheets/api/guides/concepts#cell) of the values to update.

setRange

public Sheets.Spreadsheets.Values.Update setRange(String range)

The [A1 notation](/sheets/api/guides/concepts#cell) of the values to update.

getIncludeValuesInResponse

public Boolean getIncludeValuesInResponse()

Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).

setIncludeValuesInResponse

public Sheets.Spreadsheets.Values.Update setIncludeValuesInResponse(Boolean includeValuesInResponse)

Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns).

getResponseDateTimeRenderOption

public String getResponseDateTimeRenderOption()

Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.

setResponseDateTimeRenderOption

public Sheets.Spreadsheets.Values.Update setResponseDateTimeRenderOption(String responseDateTimeRenderOption)

Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.

getResponseValueRenderOption

public String getResponseValueRenderOption()

Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.

setResponseValueRenderOption

public Sheets.Spreadsheets.Values.Update setResponseValueRenderOption(String responseValueRenderOption)

Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.

getValueInputOption

public String getValueInputOption()

How the input data should be interpreted.

setValueInputOption

public Sheets.Spreadsheets.Values.Update setValueInputOption(String valueInputOption)

How the input data should be interpreted.

set

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

Overrides:

set in class SheetsRequest<UpdateValuesResponse>