com.google.api.services.spanner.v1

Class Spanner.Projects.Instances.Databases.Restore

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<Operation>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Spanner.Projects.Instances.Databases

public class Spanner.Projects.Instances.Databases.Restore
extends SpannerRequest<Operation>

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	Restore(String parent, RestoreDatabaseRequest content) Create a new database by restoring from a completed backup.

Method Summary

Modifier and Type	Method and Description
String	getParent() Required.
Spanner.Projects.Instances.Databases.Restore	set(String parameterName, Object value)
Spanner.Projects.Instances.Databases.Restore	set$Xgafv(String $Xgafv) V1 error format.
Spanner.Projects.Instances.Databases.Restore	setAccessToken(String accessToken) OAuth access token.
Spanner.Projects.Instances.Databases.Restore	setAlt(String alt) Data format for response.
Spanner.Projects.Instances.Databases.Restore	setCallback(String callback) JSONP
Spanner.Projects.Instances.Databases.Restore	setFields(String fields) Selector specifying which fields to include in a partial response.
Spanner.Projects.Instances.Databases.Restore	setKey(String key) API key.
Spanner.Projects.Instances.Databases.Restore	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Spanner.Projects.Instances.Databases.Restore	setParent(String parent) Required.
Spanner.Projects.Instances.Databases.Restore	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Spanner.Projects.Instances.Databases.Restore	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Spanner.Projects.Instances.Databases.Restore	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Spanner.Projects.Instances.Databases.Restore	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

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, 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

Restore

protected Restore(String parent,
                  RestoreDatabaseRequest content)

Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database long-running operation has a name of the format `projects//instances//databases//operations/`, and can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreDatabaseMetadata. The response type is Database, if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete. Create a request for the method "databases.restore". 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:

parent - Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form `projects//instances/`.

content - the RestoreDatabaseRequest

Since:

1.13

Method Detail

set$Xgafv

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

Description copied from class: SpannerRequest

V1 error format.

Overrides:

set$Xgafv in class SpannerRequest<Operation>

setAccessToken

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

Description copied from class: SpannerRequest

OAuth access token.

Overrides:

setAccessToken in class SpannerRequest<Operation>

setAlt

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

Description copied from class: SpannerRequest

Data format for response.

Overrides:

setAlt in class SpannerRequest<Operation>

setCallback

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

Description copied from class: SpannerRequest

JSONP

Overrides:

setCallback in class SpannerRequest<Operation>

setFields

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

Description copied from class: SpannerRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class SpannerRequest<Operation>

setKey

public Spanner.Projects.Instances.Databases.Restore 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<Operation>

setOauthToken

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

Description copied from class: SpannerRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class SpannerRequest<Operation>

setPrettyPrint

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

Description copied from class: SpannerRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class SpannerRequest<Operation>

setQuotaUser

public Spanner.Projects.Instances.Databases.Restore 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<Operation>

setUploadType

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

Description copied from class: SpannerRequest

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

Overrides:

setUploadType in class SpannerRequest<Operation>

setUploadProtocol

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

Description copied from class: SpannerRequest

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

Overrides:

setUploadProtocol in class SpannerRequest<Operation>

getParent

public String getParent()

Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form `projects//instances/`.

setParent

public Spanner.Projects.Instances.Databases.Restore setParent(String parent)

Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form `projects//instances/`.

set

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

Overrides:

set in class SpannerRequest<Operation>