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

Class BatchUpdateValuesRequest

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class BatchUpdateValuesRequest
extends com.google.api.client.json.GenericJson

The request for updating more than one range of values in 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: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
BatchUpdateValuesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
BatchUpdateValuesRequest	clone()
java.util.List<ValueRange>	getData() The new values to apply to the spreadsheet.
java.lang.Boolean	getIncludeValuesInResponse() Determines if the update response should include the values of the cells that were updated.
java.lang.String	getResponseDateTimeRenderOption() Determines how dates, times, and durations in the response should be rendered.
java.lang.String	getResponseValueRenderOption() Determines how values in the response should be rendered.
java.lang.String	getValueInputOption() How the input data should be interpreted.
BatchUpdateValuesRequest	set(java.lang.String fieldName, java.lang.Object value)
BatchUpdateValuesRequest	setData(java.util.List<ValueRange> data) The new values to apply to the spreadsheet.
BatchUpdateValuesRequest	setIncludeValuesInResponse(java.lang.Boolean includeValuesInResponse) Determines if the update response should include the values of the cells that were updated.
BatchUpdateValuesRequest	setResponseDateTimeRenderOption(java.lang.String responseDateTimeRenderOption) Determines how dates, times, and durations in the response should be rendered.
BatchUpdateValuesRequest	setResponseValueRenderOption(java.lang.String responseValueRenderOption) Determines how values in the response should be rendered.
BatchUpdateValuesRequest	setValueInputOption(java.lang.String valueInputOption) How the input data should be interpreted.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BatchUpdateValuesRequest

public BatchUpdateValuesRequest()

Method Detail

getData

public java.util.List<ValueRange> getData()

The new values to apply to the spreadsheet.

Returns:

value or null for none

setData

public BatchUpdateValuesRequest setData(java.util.List<ValueRange> data)

The new values to apply to the spreadsheet.

Parameters:

data - data or null for none

getIncludeValuesInResponse

public java.lang.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. The `updatedData` field within each of the BatchUpdateValuesResponse.responses will contain the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns).

Returns:

value or null for none

setIncludeValuesInResponse

public BatchUpdateValuesRequest setIncludeValuesInResponse(java.lang.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. The `updatedData` field within each of the BatchUpdateValuesResponse.responses will contain the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns).

Parameters:

includeValuesInResponse - includeValuesInResponse or null for none

getResponseDateTimeRenderOption

public java.lang.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 [DateTimeRenderOption.SERIAL_NUMBER].

Returns:

value or null for none

setResponseDateTimeRenderOption

public BatchUpdateValuesRequest setResponseDateTimeRenderOption(java.lang.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 [DateTimeRenderOption.SERIAL_NUMBER].

Parameters:

responseDateTimeRenderOption - responseDateTimeRenderOption or null for none

getResponseValueRenderOption

public java.lang.String getResponseValueRenderOption()

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

Returns:

value or null for none

setResponseValueRenderOption

public BatchUpdateValuesRequest setResponseValueRenderOption(java.lang.String responseValueRenderOption)

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

Parameters:

responseValueRenderOption - responseValueRenderOption or null for none

getValueInputOption

public java.lang.String getValueInputOption()

How the input data should be interpreted.

Returns:

value or null for none

setValueInputOption

public BatchUpdateValuesRequest setValueInputOption(java.lang.String valueInputOption)

How the input data should be interpreted.

Parameters:

valueInputOption - valueInputOption or null for none

set

public BatchUpdateValuesRequest set(java.lang.String fieldName,
                           java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public BatchUpdateValuesRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson