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

Class BatchUpdateValuesByDataFilterRequest

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.BatchUpdateValuesByDataFilterRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class BatchUpdateValuesByDataFilterRequest
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: 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

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>

Constructor Summary

Constructors

Constructor and Description
BatchUpdateValuesByDataFilterRequest()

Method Summary

Modifier and Type	Method and Description
BatchUpdateValuesByDataFilterRequest	clone()
List<DataFilterValueRange>	getData() The new values to apply to the spreadsheet.
Boolean	getIncludeValuesInResponse() Determines if the update response should include the values of the cells that were updated.
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	getValueInputOption() How the input data should be interpreted.
BatchUpdateValuesByDataFilterRequest	set(String fieldName, Object value)
BatchUpdateValuesByDataFilterRequest	setData(List<DataFilterValueRange> data) The new values to apply to the spreadsheet.
BatchUpdateValuesByDataFilterRequest	setIncludeValuesInResponse(Boolean includeValuesInResponse) Determines if the update response should include the values of the cells that were updated.
BatchUpdateValuesByDataFilterRequest	setResponseDateTimeRenderOption(String responseDateTimeRenderOption) Determines how dates, times, and durations in the response should be rendered.
BatchUpdateValuesByDataFilterRequest	setResponseValueRenderOption(String responseValueRenderOption) Determines how values in the response should be rendered.
BatchUpdateValuesByDataFilterRequest	setValueInputOption(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, 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

BatchUpdateValuesByDataFilterRequest

public BatchUpdateValuesByDataFilterRequest()

Method Detail

getData

public List<DataFilterValueRange> getData()

The new values to apply to the spreadsheet. If more than one range is matched by the specified DataFilter the specified values are applied to all of those ranges.

Returns:

value or null for none

setData

public BatchUpdateValuesByDataFilterRequest setData(List<DataFilterValueRange> data)

The new values to apply to the spreadsheet. If more than one range is matched by the specified DataFilter the specified values are applied to all of those ranges.

Parameters:

data - data or null for none

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. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains 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).

Returns:

value or null for none

setIncludeValuesInResponse

public BatchUpdateValuesByDataFilterRequest 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. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains 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).

Parameters:

includeValuesInResponse - includeValuesInResponse or null for none

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.

Returns:

value or null for none

setResponseDateTimeRenderOption

public BatchUpdateValuesByDataFilterRequest 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.

Parameters:

responseDateTimeRenderOption - responseDateTimeRenderOption or null for none

getResponseValueRenderOption

public String getResponseValueRenderOption()

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

Returns:

value or null for none

setResponseValueRenderOption

public BatchUpdateValuesByDataFilterRequest setResponseValueRenderOption(String responseValueRenderOption)

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

Parameters:

responseValueRenderOption - responseValueRenderOption or null for none

getValueInputOption

public String getValueInputOption()

How the input data should be interpreted.

Returns:

value or null for none

setValueInputOption

public BatchUpdateValuesByDataFilterRequest setValueInputOption(String valueInputOption)

How the input data should be interpreted.

Parameters:

valueInputOption - valueInputOption or null for none

set

public BatchUpdateValuesByDataFilterRequest set(String fieldName,
                                                Object value)

Overrides:

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

clone

public BatchUpdateValuesByDataFilterRequest clone()

Overrides:

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