com.google.api.services.spanner.v1

Class SpannerRequest<T>

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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.spanner.v1.SpannerRequest<T>

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Direct Known Subclasses:

Spanner.Projects.InstanceConfigs.Get, Spanner.Projects.InstanceConfigs.List, Spanner.Projects.Instances.BackupOperations.List, Spanner.Projects.Instances.Backups.Create, Spanner.Projects.Instances.Backups.Delete, Spanner.Projects.Instances.Backups.Get, Spanner.Projects.Instances.Backups.GetIamPolicy, Spanner.Projects.Instances.Backups.List, Spanner.Projects.Instances.Backups.Operations.Cancel, Spanner.Projects.Instances.Backups.Operations.Delete, Spanner.Projects.Instances.Backups.Operations.Get, Spanner.Projects.Instances.Backups.Operations.List, Spanner.Projects.Instances.Backups.Patch, Spanner.Projects.Instances.Backups.SetIamPolicy, Spanner.Projects.Instances.Backups.TestIamPermissions, Spanner.Projects.Instances.Create, Spanner.Projects.Instances.DatabaseOperations.List, Spanner.Projects.Instances.Databases.Create, Spanner.Projects.Instances.Databases.DropDatabase, Spanner.Projects.Instances.Databases.Get, Spanner.Projects.Instances.Databases.GetDdl, Spanner.Projects.Instances.Databases.GetIamPolicy, Spanner.Projects.Instances.Databases.List, Spanner.Projects.Instances.Databases.Operations.Cancel, Spanner.Projects.Instances.Databases.Operations.Delete, Spanner.Projects.Instances.Databases.Operations.Get, Spanner.Projects.Instances.Databases.Operations.List, Spanner.Projects.Instances.Databases.Restore, Spanner.Projects.Instances.Databases.Sessions.BatchCreate, Spanner.Projects.Instances.Databases.Sessions.BeginTransaction, Spanner.Projects.Instances.Databases.Sessions.Commit, Spanner.Projects.Instances.Databases.Sessions.Create, Spanner.Projects.Instances.Databases.Sessions.Delete, Spanner.Projects.Instances.Databases.Sessions.ExecuteBatchDml, Spanner.Projects.Instances.Databases.Sessions.ExecuteSql, Spanner.Projects.Instances.Databases.Sessions.ExecuteStreamingSql, Spanner.Projects.Instances.Databases.Sessions.Get, Spanner.Projects.Instances.Databases.Sessions.List, Spanner.Projects.Instances.Databases.Sessions.PartitionQuery, Spanner.Projects.Instances.Databases.Sessions.PartitionRead, Spanner.Projects.Instances.Databases.Sessions.Read, Spanner.Projects.Instances.Databases.Sessions.Rollback, Spanner.Projects.Instances.Databases.Sessions.StreamingRead, Spanner.Projects.Instances.Databases.SetIamPolicy, Spanner.Projects.Instances.Databases.TestIamPermissions, Spanner.Projects.Instances.Databases.UpdateDdl, Spanner.Projects.Instances.Delete, Spanner.Projects.Instances.Get, Spanner.Projects.Instances.GetIamPolicy, Spanner.Projects.Instances.List, Spanner.Projects.Instances.Operations.Cancel, Spanner.Projects.Instances.Operations.Delete, Spanner.Projects.Instances.Operations.Get, Spanner.Projects.Instances.Operations.List, Spanner.Projects.Instances.Patch, Spanner.Projects.Instances.SetIamPolicy, Spanner.Projects.Instances.TestIamPermissions

public abstract class SpannerRequest<T>
extends com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

Spanner request.

Since:

1.3

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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

java.util.Map.Entry<K,V>

Field Summary

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Constructor and Description
SpannerRequest(Spanner client, java.lang.String method, java.lang.String uriTemplate, java.lang.Object content, java.lang.Class<T> responseClass)

Method Summary

Modifier and Type	Method and Description
java.lang.String	get$Xgafv() V1 error format.
Spanner	getAbstractGoogleClient()
java.lang.String	getAccessToken() OAuth access token.
java.lang.String	getAlt() Data format for response.
java.lang.String	getCallback() JSONP
java.lang.String	getFields() Selector specifying which fields to include in a partial response.
java.lang.String	getKey() API key.
java.lang.String	getOauthToken() OAuth 2.0 token for the current user.
java.lang.Boolean	getPrettyPrint() Returns response with indentations and line breaks.
java.lang.String	getQuotaUser() Available to use for quota purposes for server-side applications.
java.lang.String	getUploadProtocol() Upload protocol for media (e.g.
java.lang.String	getUploadType() Legacy upload protocol for media (e.g.
SpannerRequest<T>	set(java.lang.String parameterName, java.lang.Object value)
SpannerRequest<T>	set$Xgafv(java.lang.String $Xgafv) V1 error format.
SpannerRequest<T>	setAccessToken(java.lang.String accessToken) OAuth access token.
SpannerRequest<T>	setAlt(java.lang.String alt) Data format for response.
SpannerRequest<T>	setCallback(java.lang.String callback) JSONP
SpannerRequest<T>	setDisableGZipContent(boolean disableGZipContent)
SpannerRequest<T>	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
SpannerRequest<T>	setKey(java.lang.String key) API key.
SpannerRequest<T>	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
SpannerRequest<T>	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
SpannerRequest<T>	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
SpannerRequest<T>	setRequestHeaders(com.google.api.client.http.HttpHeaders headers)
SpannerRequest<T>	setUploadProtocol(java.lang.String uploadProtocol) Upload protocol for media (e.g.
SpannerRequest<T>	setUploadType(java.lang.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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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

SpannerRequest

public SpannerRequest(Spanner client,
                      java.lang.String method,
                      java.lang.String uriTemplate,
                      java.lang.Object content,
                      java.lang.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 java.lang.String get$Xgafv()

V1 error format.

set$Xgafv

public SpannerRequest<T> set$Xgafv(java.lang.String $Xgafv)

V1 error format.

getAccessToken

public java.lang.String getAccessToken()

OAuth access token.

setAccessToken

public SpannerRequest<T> setAccessToken(java.lang.String accessToken)

OAuth access token.

getAlt

public java.lang.String getAlt()

Data format for response. [default: json]

setAlt

public SpannerRequest<T> setAlt(java.lang.String alt)

Data format for response.

getCallback

public java.lang.String getCallback()

JSONP

setCallback

public SpannerRequest<T> setCallback(java.lang.String callback)

JSONP

getFields

public java.lang.String getFields()

Selector specifying which fields to include in a partial response.

setFields

public SpannerRequest<T> setFields(java.lang.String fields)

Selector specifying which fields to include in a partial response.

getKey

public java.lang.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 SpannerRequest<T> setKey(java.lang.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 java.lang.String getOauthToken()

OAuth 2.0 token for the current user.

setOauthToken

public SpannerRequest<T> setOauthToken(java.lang.String oauthToken)

OAuth 2.0 token for the current user.

getPrettyPrint

public java.lang.Boolean getPrettyPrint()

Returns response with indentations and line breaks. [default: true]

setPrettyPrint

public SpannerRequest<T> setPrettyPrint(java.lang.Boolean prettyPrint)

Returns response with indentations and line breaks.

getQuotaUser

public java.lang.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 SpannerRequest<T> setQuotaUser(java.lang.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 java.lang.String getUploadType()

Legacy upload protocol for media (e.g. "media", "multipart").

setUploadType

public SpannerRequest<T> setUploadType(java.lang.String uploadType)

Legacy upload protocol for media (e.g. "media", "multipart").

getUploadProtocol

public java.lang.String getUploadProtocol()

Upload protocol for media (e.g. "raw", "multipart").

setUploadProtocol

public SpannerRequest<T> setUploadProtocol(java.lang.String uploadProtocol)

Upload protocol for media (e.g. "raw", "multipart").

getAbstractGoogleClient

public final Spanner getAbstractGoogleClient()

Overrides:

getAbstractGoogleClient in class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

setDisableGZipContent

public SpannerRequest<T> setDisableGZipContent(boolean disableGZipContent)

Overrides:

setDisableGZipContent in class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

setRequestHeaders

public SpannerRequest<T> setRequestHeaders(com.google.api.client.http.HttpHeaders headers)

Overrides:

setRequestHeaders in class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

set

public SpannerRequest<T> set(java.lang.String parameterName,
                             java.lang.Object value)

Overrides:

set in class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>