target.apidocs.com.google.api.services.sheets.v4.SheetsRequest.html Maven / Gradle / Ivy
SheetsRequest (Google Sheets API v4-rev20220322-1.32.1)
com.google.api.services.sheets.v4
Class SheetsRequest<T>
- 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<T>
-
- Direct Known Subclasses:
- Sheets.Spreadsheets.BatchUpdate, Sheets.Spreadsheets.Create, Sheets.Spreadsheets.DeveloperMetadata.Get, Sheets.Spreadsheets.DeveloperMetadata.Search, Sheets.Spreadsheets.Get, Sheets.Spreadsheets.GetByDataFilter, Sheets.Spreadsheets.SheetsOperations.CopyTo, Sheets.Spreadsheets.Values.Append, Sheets.Spreadsheets.Values.BatchClear, Sheets.Spreadsheets.Values.BatchClearByDataFilter, Sheets.Spreadsheets.Values.BatchGet, Sheets.Spreadsheets.Values.BatchGetByDataFilter, Sheets.Spreadsheets.Values.BatchUpdate, Sheets.Spreadsheets.Values.BatchUpdateByDataFilter, Sheets.Spreadsheets.Values.Clear, Sheets.Spreadsheets.Values.Get, Sheets.Spreadsheets.Values.Update
public abstract class SheetsRequest<T>
extends AbstractGoogleJsonClientRequest<T>
Sheets request.
- Since:
- 1.3
-
-
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>
-
Field Summary
-
Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
USER_AGENT_SUFFIX
-
Constructor Summary
Constructors
Constructor and Description
SheetsRequest(Sheets client,
String method,
String uriTemplate,
Object content,
Class<T> responseClass)
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
String
get$Xgafv()
V1 error format.
Sheets
getAbstractGoogleClient()
String
getAccessToken()
OAuth access token.
String
getAlt()
Data format for response.
String
getCallback()
JSONP
String
getFields()
Selector specifying which fields to include in a partial response.
String
getKey()
API key.
String
getOauthToken()
OAuth 2.0 token for the current user.
Boolean
getPrettyPrint()
Returns response with indentations and line breaks.
String
getQuotaUser()
Available to use for quota purposes for server-side applications.
String
getUploadProtocol()
Upload protocol for media (e.g.
String
getUploadType()
Legacy upload protocol for media (e.g.
SheetsRequest<T>
set(String parameterName,
Object value)
SheetsRequest<T>
set$Xgafv(String $Xgafv)
V1 error format.
SheetsRequest<T>
setAccessToken(String accessToken)
OAuth access token.
SheetsRequest<T>
setAlt(String alt)
Data format for response.
SheetsRequest<T>
setCallback(String callback)
JSONP
SheetsRequest<T>
setDisableGZipContent(boolean disableGZipContent)
SheetsRequest<T>
setFields(String fields)
Selector specifying which fields to include in a partial response.
SheetsRequest<T>
setKey(String key)
API key.
SheetsRequest<T>
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
SheetsRequest<T>
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
SheetsRequest<T>
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
SheetsRequest<T>
setRequestHeaders(HttpHeaders headers)
SheetsRequest<T>
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
SheetsRequest<T>
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
-
Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue
-
Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream
-
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
-
SheetsRequest
public SheetsRequest(Sheets client,
String method,
String uriTemplate,
Object content,
Class<T> responseClass)
- Parameters:
client
- Google client
method
- HTTP Method
uriTemplate
- URI template for the path relative to the base URL. If it starts with a "/"
the base path from the base URL will be stripped out. The URI template can also be a
full URL. URI template expansion is done using
UriTemplate.expand(String, String, Object, boolean)
content
- A POJO that can be serialized into JSON or null
for none
responseClass
- response class to parse into
-
Method Detail
-
get$Xgafv
public String get$Xgafv()
V1 error format.
-
set$Xgafv
public SheetsRequest<T> set$Xgafv(String $Xgafv)
V1 error format.
-
getAccessToken
public String getAccessToken()
OAuth access token.
-
setAccessToken
public SheetsRequest<T> setAccessToken(String accessToken)
OAuth access token.
-
getAlt
public String getAlt()
Data format for response. [default: json]
-
setAlt
public SheetsRequest<T> setAlt(String alt)
Data format for response.
-
getCallback
public String getCallback()
JSONP
-
setCallback
public SheetsRequest<T> setCallback(String callback)
JSONP
-
getFields
public String getFields()
Selector specifying which fields to include in a partial response.
-
setFields
public SheetsRequest<T> setFields(String fields)
Selector specifying which fields to include in a partial response.
-
getKey
public String getKey()
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.
-
setKey
public SheetsRequest<T> setKey(String key)
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.
-
getOauthToken
public String getOauthToken()
OAuth 2.0 token for the current user.
-
setOauthToken
public SheetsRequest<T> setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
-
getPrettyPrint
public Boolean getPrettyPrint()
Returns response with indentations and line breaks. [default: true]
-
setPrettyPrint
public SheetsRequest<T> setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
-
getQuotaUser
public String getQuotaUser()
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.
-
setQuotaUser
public SheetsRequest<T> setQuotaUser(String quotaUser)
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.
-
getUploadType
public String getUploadType()
Legacy upload protocol for media (e.g. "media", "multipart").
-
setUploadType
public SheetsRequest<T> setUploadType(String uploadType)
Legacy upload protocol for media (e.g. "media", "multipart").
-
getUploadProtocol
public String getUploadProtocol()
Upload protocol for media (e.g. "raw", "multipart").
-
setUploadProtocol
public SheetsRequest<T> setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g. "raw", "multipart").
-
getAbstractGoogleClient
public final Sheets getAbstractGoogleClient()
- Overrides:
getAbstractGoogleClient
in class AbstractGoogleJsonClientRequest<T>
-
setDisableGZipContent
public SheetsRequest<T> setDisableGZipContent(boolean disableGZipContent)
- Overrides:
setDisableGZipContent
in class AbstractGoogleJsonClientRequest<T>
-
setRequestHeaders
public SheetsRequest<T> setRequestHeaders(HttpHeaders headers)
- Overrides:
setRequestHeaders
in class AbstractGoogleJsonClientRequest<T>
-
set
public SheetsRequest<T> set(String parameterName,
Object value)
- Overrides:
set
in class AbstractGoogleJsonClientRequest<T>
Copyright © 2011–2022 Google. All rights reserved.