Sheets.Spreadsheets.Values.BatchGet (Google Sheets API v4-rev20210629-1.32.1)

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<BatchGetValuesResponse>
        
        com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchGet

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: Sheets.Spreadsheets.Values

public class Sheets.Spreadsheets.Values.BatchGet
extends SheetsRequest<BatchGetValuesResponse>

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  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
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected BatchGet(String spreadsheetId)
Returns one or more ranges of values from a spreadsheet.

Constructors
Modifier	Constructor and Description
`protected`	`BatchGet(String spreadsheetId)` Returns one or more ranges of values from a spreadsheet.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`String`	`getDateTimeRenderOption()` How dates, times, and durations should be represented in the output.
`String`	`getMajorDimension()` The major dimension that results should use.
`List<String>`	`getRanges()` The A1 notation or R1C1 notation of the range to retrieve values from.
`String`	`getSpreadsheetId()` The ID of the spreadsheet to retrieve data from.
`String`	`getValueRenderOption()` How values should be represented in the output.
`Sheets.Spreadsheets.Values.BatchGet`	`set(String parameterName, Object value)`
`Sheets.Spreadsheets.Values.BatchGet`	`set$Xgafv(String $Xgafv)` V1 error format.
`Sheets.Spreadsheets.Values.BatchGet`	`setAccessToken(String accessToken)` OAuth access token.
`Sheets.Spreadsheets.Values.BatchGet`	`setAlt(String alt)` Data format for response.
`Sheets.Spreadsheets.Values.BatchGet`	`setCallback(String callback)` JSONP
`Sheets.Spreadsheets.Values.BatchGet`	`setDateTimeRenderOption(String dateTimeRenderOption)` How dates, times, and durations should be represented in the output.
`Sheets.Spreadsheets.Values.BatchGet`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Sheets.Spreadsheets.Values.BatchGet`	`setKey(String key)` API key.
`Sheets.Spreadsheets.Values.BatchGet`	`setMajorDimension(String majorDimension)` The major dimension that results should use.
`Sheets.Spreadsheets.Values.BatchGet`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Sheets.Spreadsheets.Values.BatchGet`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Sheets.Spreadsheets.Values.BatchGet`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Sheets.Spreadsheets.Values.BatchGet`	`setRanges(List<String> ranges)` The A1 notation or R1C1 notation of the range to retrieve values from.
`Sheets.Spreadsheets.Values.BatchGet`	`setSpreadsheetId(String spreadsheetId)` The ID of the spreadsheet to retrieve data from.
`Sheets.Spreadsheets.Values.BatchGet`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Sheets.Spreadsheets.Values.BatchGet`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.
`Sheets.Spreadsheets.Values.BatchGet`	`setValueRenderOption(String valueRenderOption)` How values should be represented in the output.

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.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
  - BatchGet
```
protected BatchGet(String spreadsheetId)
```
    Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Create a request for the method "values.batchGet". 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 retrieve data from.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<BatchGetValuesResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<BatchGetValuesResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Sheets.Spreadsheets.Values.BatchGet set$Xgafv(String $Xgafv)
```
    Description copied from class: SheetsRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class SheetsRequest<BatchGetValuesResponse>
  - setAccessToken
```
public Sheets.Spreadsheets.Values.BatchGet setAccessToken(String accessToken)
```
    Description copied from class: SheetsRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class SheetsRequest<BatchGetValuesResponse>
  - setAlt
```
public Sheets.Spreadsheets.Values.BatchGet setAlt(String alt)
```
    Description copied from class: SheetsRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class SheetsRequest<BatchGetValuesResponse>
  - setCallback
```
public Sheets.Spreadsheets.Values.BatchGet setCallback(String callback)
```
    Description copied from class: SheetsRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class SheetsRequest<BatchGetValuesResponse>
  - setFields
```
public Sheets.Spreadsheets.Values.BatchGet setFields(String fields)
```
    Description copied from class: SheetsRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class SheetsRequest<BatchGetValuesResponse>
  - setKey
```
public Sheets.Spreadsheets.Values.BatchGet 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<BatchGetValuesResponse>
  - setOauthToken
```
public Sheets.Spreadsheets.Values.BatchGet setOauthToken(String oauthToken)
```
    Description copied from class: SheetsRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class SheetsRequest<BatchGetValuesResponse>
  - setPrettyPrint
```
public Sheets.Spreadsheets.Values.BatchGet setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: SheetsRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class SheetsRequest<BatchGetValuesResponse>
  - setQuotaUser
```
public Sheets.Spreadsheets.Values.BatchGet 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<BatchGetValuesResponse>
  - setUploadType
```
public Sheets.Spreadsheets.Values.BatchGet setUploadType(String uploadType)
```
    Description copied from class: SheetsRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class SheetsRequest<BatchGetValuesResponse>
  - setUploadProtocol
```
public Sheets.Spreadsheets.Values.BatchGet setUploadProtocol(String uploadProtocol)
```
    Description copied from class: SheetsRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class SheetsRequest<BatchGetValuesResponse>
  - getSpreadsheetId
```
public String getSpreadsheetId()
```
    The ID of the spreadsheet to retrieve data from.
  - setSpreadsheetId
```
public Sheets.Spreadsheets.Values.BatchGet setSpreadsheetId(String spreadsheetId)
```
    The ID of the spreadsheet to retrieve data from.
  - getDateTimeRenderOption
```
public String getDateTimeRenderOption()
```
    How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.
  - setDateTimeRenderOption
```
public Sheets.Spreadsheets.Values.BatchGet setDateTimeRenderOption(String dateTimeRenderOption)
```
    How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.
  - getMajorDimension
```
public String getMajorDimension()
```
    The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.
  - setMajorDimension
```
public Sheets.Spreadsheets.Values.BatchGet setMajorDimension(String majorDimension)
```
    The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` returns `[[1,3],[2,4]]`.
  - getRanges
```
public List<String> getRanges()
```
    The A1 notation or R1C1 notation of the range to retrieve values from.
  - setRanges
```
public Sheets.Spreadsheets.Values.BatchGet setRanges(List<String> ranges)
```
    The A1 notation or R1C1 notation of the range to retrieve values from.
  - getValueRenderOption
```
public String getValueRenderOption()
```
    How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
  - setValueRenderOption
```
public Sheets.Spreadsheets.Values.BatchGet setValueRenderOption(String valueRenderOption)
```
    How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
  - set
```
public Sheets.Spreadsheets.Values.BatchGet set(String parameterName,
                                               Object value)
```
    Overrides:
    
    set in class SheetsRequest<BatchGetValuesResponse>

Class Sheets.Spreadsheets.Values.BatchGet

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

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

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.sheets.v4.SheetsRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

BatchGet

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getSpreadsheetId

setSpreadsheetId

getDateTimeRenderOption

setDateTimeRenderOption

getMajorDimension

setMajorDimension

getRanges

setRanges

getValueRenderOption

setValueRenderOption

set