target.apidocs.com.google.api.services.sheets.v4.model.BatchUpdateValuesRequest.html Maven / Gradle / Ivy
BatchUpdateValuesRequest (Google Sheets API v4-rev20240319-2.0.0)
com.google.api.services.sheets.v4.model
Class BatchUpdateValuesRequest
- 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.BatchUpdateValuesRequest
-
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:
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>
-
Constructor Summary
Constructors
Constructor and Description
BatchUpdateValuesRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
BatchUpdateValuesRequest
clone()
List<ValueRange>
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.
BatchUpdateValuesRequest
set(String fieldName,
Object value)
BatchUpdateValuesRequest
setData(List<ValueRange> data)
The new values to apply to the spreadsheet.
BatchUpdateValuesRequest
setIncludeValuesInResponse(Boolean includeValuesInResponse)
Determines if the update response should include the values of the cells that were updated.
BatchUpdateValuesRequest
setResponseDateTimeRenderOption(String responseDateTimeRenderOption)
Determines how dates, times, and durations in the response should be rendered.
BatchUpdateValuesRequest
setResponseValueRenderOption(String responseValueRenderOption)
Determines how values in the response should be rendered.
BatchUpdateValuesRequest
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
-
-
Method Detail
-
getData
public List<ValueRange> getData()
The new values to apply to the spreadsheet.
- Returns:
- value or
null
for none
-
setData
public BatchUpdateValuesRequest setData(List<ValueRange> data)
The new values to apply to the spreadsheet.
- 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 BatchUpdateValuesRequest 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 BatchUpdateValuesRequest 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 BatchUpdateValuesRequest 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 BatchUpdateValuesRequest setValueInputOption(String valueInputOption)
How the input data should be interpreted.
- Parameters:
valueInputOption
- valueInputOption or null
for none
-
set
public BatchUpdateValuesRequest set(String fieldName,
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
Copyright © 2011–2024 Google. All rights reserved.