com.google.api.services.spanner.v1

Class Spanner.Projects.Instances.Databases.Patch

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.Patch

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Spanner.Projects.Instances.Databases

public class Spanner.Projects.Instances.Databases.Patch
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	Patch(String name, Database content) Updates a Cloud Spanner database.

Method Summary

Modifier and Type	Method and Description
String	getName() Required.
String	getUpdateMask() Required.
Spanner.Projects.Instances.Databases.Patch	set(String parameterName, Object value)
Spanner.Projects.Instances.Databases.Patch	set$Xgafv(String $Xgafv) V1 error format.
Spanner.Projects.Instances.Databases.Patch	setAccessToken(String accessToken) OAuth access token.
Spanner.Projects.Instances.Databases.Patch	setAlt(String alt) Data format for response.
Spanner.Projects.Instances.Databases.Patch	setCallback(String callback) JSONP
Spanner.Projects.Instances.Databases.Patch	setFields(String fields) Selector specifying which fields to include in a partial response.
Spanner.Projects.Instances.Databases.Patch	setKey(String key) API key.
Spanner.Projects.Instances.Databases.Patch	setName(String name) Required.
Spanner.Projects.Instances.Databases.Patch	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Spanner.Projects.Instances.Databases.Patch	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Spanner.Projects.Instances.Databases.Patch	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Spanner.Projects.Instances.Databases.Patch	setUpdateMask(String updateMask) Required.
Spanner.Projects.Instances.Databases.Patch	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Spanner.Projects.Instances.Databases.Patch	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

Patch

protected Patch(String name,
                Database content)

Updates a Cloud Spanner database. The returned long-running operation can be used to track the progress of updating the database. If the named database does not exist, returns `NOT_FOUND`. While the operation is pending: * The database's reconciling field is set to true. * Cancelling the operation is best-effort. If the cancellation succeeds, the operation metadata's cancel_time is set, the updates are reverted, and the operation terminates with a `CANCELLED` status. * New UpdateDatabase requests will return a `FAILED_PRECONDITION` error until the pending operation is done (returns successfully or with error). * Reading the database via the API continues to give the pre-request values. Upon completion of the returned operation: * The new values are in effect and readable via the API. * The database's reconciling field becomes false. The returned long-running operation will have a name of the format `projects//instances//databases//operations/` and can be used to track the database modification. The metadata field type is UpdateDatabaseMetadata. The response field type is Database, if successful. Create a request for the method "databases.patch". 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 name of the database. Values are of the form `projects//instances//databases/`, where `` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database.

content - the Database

Since:

1.13

Method Detail

set$Xgafv

public Spanner.Projects.Instances.Databases.Patch 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.Patch setAccessToken(String accessToken)

Description copied from class: SpannerRequest

OAuth access token.

Overrides:

setAccessToken in class SpannerRequest<Operation>

setAlt

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

Description copied from class: SpannerRequest

Data format for response.

Overrides:

setAlt in class SpannerRequest<Operation>

setCallback

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

Description copied from class: SpannerRequest

JSONP

Overrides:

setCallback in class SpannerRequest<Operation>

setFields

public Spanner.Projects.Instances.Databases.Patch 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.Patch 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.Patch 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.Patch 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.Patch 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.Patch 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.Patch setUploadProtocol(String uploadProtocol)

Description copied from class: SpannerRequest

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

Overrides:

setUploadProtocol in class SpannerRequest<Operation>

getName

public String getName()

Required. The name of the database. Values are of the form `projects//instances//databases/`, where `` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database.

setName

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

Required. The name of the database. Values are of the form `projects//instances//databases/`, where `` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database.

getUpdateMask

public String getUpdateMask()

Required. The list of fields to update. Currently, only `enable_drop_protection` field can be updated.

setUpdateMask

public Spanner.Projects.Instances.Databases.Patch setUpdateMask(String updateMask)

Required. The list of fields to update. Currently, only `enable_drop_protection` field can be updated.

set

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

Overrides:

set in class SpannerRequest<Operation>