target.apidocs.com.google.api.services.sheets.v4.model.ValueRange.html Maven / Gradle / Ivy
ValueRange (Google Sheets API v4-rev20230526-2.0.0)
com.google.api.services.sheets.v4.model
Class ValueRange
- 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.ValueRange
-
public final class ValueRange
extends com.google.api.client.json.GenericJson
Data within a range of the 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
ValueRange()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
ValueRangeclone()
StringgetMajorDimension()
The major dimension of the values.
StringgetRange()
The range the values cover, in [A1 notation](/sheets/api/guides/concepts#cell).
List<List<Object>>getValues()
The data that was read or to be written.
ValueRangeset(String fieldName,
Object value)
ValueRangesetMajorDimension(String majorDimension)
The major dimension of the values.
ValueRangesetRange(String range)
The range the values cover, in [A1 notation](/sheets/api/guides/concepts#cell).
ValueRangesetValues(List<List<Object>> values)
The data that was read or to be written.
-
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
-
getMajorDimension
public String getMajorDimension()
The major dimension of the values. For output, if the spreadsheet data is:
`A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return
`[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
`[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will
set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will
set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS.
- Returns:
- value or
null for none
-
setMajorDimension
public ValueRange setMajorDimension(String majorDimension)
The major dimension of the values. For output, if the spreadsheet data is:
`A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return
`[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
`[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will
set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will
set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS.
- Parameters:
majorDimension - majorDimension or null for none
-
getRange
public String getRange()
The range the values cover, in [A1 notation](/sheets/api/guides/concepts#cell). For output,
this range indicates the entire requested range, even though the values will exclude trailing
rows and columns. When appending values, this field represents the range to search for a table,
after which values will be appended.
- Returns:
- value or
null for none
-
setRange
public ValueRange setRange(String range)
The range the values cover, in [A1 notation](/sheets/api/guides/concepts#cell). For output,
this range indicates the entire requested range, even though the values will exclude trailing
rows and columns. When appending values, this field represents the range to search for a table,
after which values will be appended.
- Parameters:
range - range or null for none
-
getValues
public List<List<Object>> getValues()
The data that was read or to be written. This is an array of arrays, the outer array
representing all the data and each inner array representing a major dimension. Each item in the
inner array corresponds with one cell. For output, empty trailing rows and columns will not be
included. For input, supported value types are: bool, string, and double. Null values will be
skipped. To set a cell to an empty value, set the string value to an empty string.
- Returns:
- value or
null for none
-
setValues
public ValueRange setValues(List<List<Object>> values)
The data that was read or to be written. This is an array of arrays, the outer array
representing all the data and each inner array representing a major dimension. Each item in the
inner array corresponds with one cell. For output, empty trailing rows and columns will not be
included. For input, supported value types are: bool, string, and double. Null values will be
skipped. To set a cell to an empty value, set the string value to an empty string.
- Parameters:
values - values or null for none
-
set
public ValueRange set(String fieldName,
Object value)
- Overrides:
set in class com.google.api.client.json.GenericJson
-
clone
public ValueRange clone()
- Overrides:
clone in class com.google.api.client.json.GenericJson
Copyright © 2011–2023 Google. All rights reserved.