com.google.api.services.spanner.v1

Class Spanner.Projects.Instances.Databases.GetScans

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.spanner.v1.SpannerRequest<Scan>

com.google.api.services.spanner.v1.Spanner.Projects.Instances.Databases.GetScans

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Spanner.Projects.Instances.Databases

public class Spanner.Projects.Instances.Databases.GetScans
extends SpannerRequest<Scan>

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>

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GetScans(String name) Request a specific scan with Database-specific data for Cloud Key Visualizer.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getEndTime() The upper bound for the time range to retrieve Scan data for.
String	getName() Required.
String	getStartTime() These fields restrict the Database-specific information returned in the `Scan.data` field.
String	getView() Specifies which parts of the Scan should be returned in the response.
Spanner.Projects.Instances.Databases.GetScans	set(String parameterName, Object value)
Spanner.Projects.Instances.Databases.GetScans	set$Xgafv(String $Xgafv) V1 error format.
Spanner.Projects.Instances.Databases.GetScans	setAccessToken(String accessToken) OAuth access token.
Spanner.Projects.Instances.Databases.GetScans	setAlt(String alt) Data format for response.
Spanner.Projects.Instances.Databases.GetScans	setCallback(String callback) JSONP
Spanner.Projects.Instances.Databases.GetScans	setEndTime(String endTime) The upper bound for the time range to retrieve Scan data for.
Spanner.Projects.Instances.Databases.GetScans	setFields(String fields) Selector specifying which fields to include in a partial response.
Spanner.Projects.Instances.Databases.GetScans	setKey(String key) API key.
Spanner.Projects.Instances.Databases.GetScans	setName(String name) Required.
Spanner.Projects.Instances.Databases.GetScans	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Spanner.Projects.Instances.Databases.GetScans	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Spanner.Projects.Instances.Databases.GetScans	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Spanner.Projects.Instances.Databases.GetScans	setStartTime(String startTime) These fields restrict the Database-specific information returned in the `Scan.data` field.
Spanner.Projects.Instances.Databases.GetScans	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Spanner.Projects.Instances.Databases.GetScans	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Spanner.Projects.Instances.Databases.GetScans	setView(String view) Specifies which parts of the Scan should be returned in the response.

Methods inherited from class com.google.api.services.spanner.v1.SpannerRequest

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.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, 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

GetScans

protected GetScans(String name)

Request a specific scan with Database-specific data for Cloud Key Visualizer. Create a request for the method "databases.getScans". This request holds the parameters needed by the the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Spanner.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

name - Required. The unique name of the scan containing the requested information, specific to the Database service implementing this interface.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Scan>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Scan>

Throws:

IOException

set$Xgafv

public Spanner.Projects.Instances.Databases.GetScans set$Xgafv(String $Xgafv)

Description copied from class: SpannerRequest

V1 error format.

Overrides:

set$Xgafv in class SpannerRequest<Scan>

setAccessToken

public Spanner.Projects.Instances.Databases.GetScans setAccessToken(String accessToken)

Description copied from class: SpannerRequest

OAuth access token.

Overrides:

setAccessToken in class SpannerRequest<Scan>

setAlt

public Spanner.Projects.Instances.Databases.GetScans setAlt(String alt)

Description copied from class: SpannerRequest

Data format for response.

Overrides:

setAlt in class SpannerRequest<Scan>

setCallback

public Spanner.Projects.Instances.Databases.GetScans setCallback(String callback)

Description copied from class: SpannerRequest

JSONP

Overrides:

setCallback in class SpannerRequest<Scan>

setFields

public Spanner.Projects.Instances.Databases.GetScans setFields(String fields)

Description copied from class: SpannerRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class SpannerRequest<Scan>

setKey

public Spanner.Projects.Instances.Databases.GetScans setKey(String key)

Description copied from class: SpannerRequest

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 SpannerRequest<Scan>

setOauthToken

public Spanner.Projects.Instances.Databases.GetScans setOauthToken(String oauthToken)

Description copied from class: SpannerRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class SpannerRequest<Scan>

setPrettyPrint

public Spanner.Projects.Instances.Databases.GetScans setPrettyPrint(Boolean prettyPrint)

Description copied from class: SpannerRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class SpannerRequest<Scan>

setQuotaUser

public Spanner.Projects.Instances.Databases.GetScans setQuotaUser(String quotaUser)

Description copied from class: SpannerRequest

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 SpannerRequest<Scan>

setUploadType

public Spanner.Projects.Instances.Databases.GetScans setUploadType(String uploadType)

Description copied from class: SpannerRequest

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

Overrides:

setUploadType in class SpannerRequest<Scan>

setUploadProtocol

public Spanner.Projects.Instances.Databases.GetScans setUploadProtocol(String uploadProtocol)

Description copied from class: SpannerRequest

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

Overrides:

setUploadProtocol in class SpannerRequest<Scan>

getName

public String getName()

Required. The unique name of the scan containing the requested information, specific to the Database service implementing this interface.

setName

public Spanner.Projects.Instances.Databases.GetScans setName(String name)

Required. The unique name of the scan containing the requested information, specific to the Database service implementing this interface.

getEndTime

public String getEndTime()

The upper bound for the time range to retrieve Scan data for.

setEndTime

public Spanner.Projects.Instances.Databases.GetScans setEndTime(String endTime)

The upper bound for the time range to retrieve Scan data for.

getStartTime

public String getStartTime()

These fields restrict the Database-specific information returned in the `Scan.data` field. If a `View` is provided that does not include the `Scan.data` field, these are ignored. This range of time must be entirely contained within the defined time range of the targeted scan. The lower bound for the time range to retrieve Scan data for.

setStartTime

public Spanner.Projects.Instances.Databases.GetScans setStartTime(String startTime)

These fields restrict the Database-specific information returned in the `Scan.data` field. If a `View` is provided that does not include the `Scan.data` field, these are ignored. This range of time must be entirely contained within the defined time range of the targeted scan. The lower bound for the time range to retrieve Scan data for.

getView

public String getView()

Specifies which parts of the Scan should be returned in the response. Note, if left unspecified, the FULL view is assumed.

setView

public Spanner.Projects.Instances.Databases.GetScans setView(String view)

Specifies which parts of the Scan should be returned in the response. Note, if left unspecified, the FULL view is assumed.

set

public Spanner.Projects.Instances.Databases.GetScans set(String parameterName,
                                                         Object value)

Overrides:

set in class SpannerRequest<Scan>