target.apidocs.com.google.api.services.spanner.v1.Spanner.Projects.Instances.Move.html Maven / Gradle / Ivy
Spanner.Projects.Instances.Move (Cloud Spanner API v1-rev20240711-2.0.0)
com.google.api.services.spanner.v1
Class Spanner.Projects.Instances.Move
- 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.Move
-
- Enclosing class:
- Spanner.Projects.Instances
public class Spanner.Projects.Instances.Move
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>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected Move(String name,
MoveInstanceRequest content)
Moves the instance to the target instance config.
-
Method Summary
-
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
-
Move
protected Move(String name,
MoveInstanceRequest content)
Moves the instance to the target instance config. The returned long-running operation can be
used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION`
if the instance meets any of the following criteria: * Has an ongoing move to a different
instance config * Has backups * Has an ongoing update * Is under free trial * Contains any
CMEK-enabled databases While the operation is pending: * All other attempts to modify the
instance, including changes to its compute capacity, are rejected. * The following database and
backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, *
DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) *
DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both
the source and target instance configurations are subject to hourly compute and storage
charges. * The instance may experience higher read-write latencies and a higher transaction
abort rate. However, moving an instance does not cause any downtime. The returned long-running
operation will have a name of the format `/operations/` and can be used to track the move
instance operation. The metadata field type is MoveInstanceMetadata. The response field type is
Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation
is not immediate since it involves moving any data previously moved to target instance
configuration back to the original instance config. The same operation can be used to track the
progress of the cancellation. Upon successful completion of the cancellation, the operation
terminates with `CANCELLED` status. Upon completion(if not cancelled) of the returned
operation: * Instance would be successfully moved to the target instance config. * You are
billed for compute and storage in target instance config. Authorization requires
`spanner.instances.update` permission on the resource instance. For more details, please see
[documentation](https://cloud.google.com/spanner/docs/move-instance).
Create a request for the method "instances.move".
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 instance to move. Values are of the form `projects//instances/`.content - the MoveInstanceRequest- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Spanner.Projects.Instances.Move set$Xgafv(String $Xgafv)
Description copied from class: SpannerRequest
V1 error format.
- Overrides:
set$Xgafv in class SpannerRequest<Operation>
-
setAccessToken
public Spanner.Projects.Instances.Move setAccessToken(String accessToken)
Description copied from class: SpannerRequest
OAuth access token.
- Overrides:
setAccessToken in class SpannerRequest<Operation>
-
setAlt
public Spanner.Projects.Instances.Move setAlt(String alt)
Description copied from class: SpannerRequest
Data format for response.
- Overrides:
setAlt in class SpannerRequest<Operation>
-
setCallback
public Spanner.Projects.Instances.Move setCallback(String callback)
Description copied from class: SpannerRequest
JSONP
- Overrides:
setCallback in class SpannerRequest<Operation>
-
setFields
public Spanner.Projects.Instances.Move 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.Move 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.Move 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.Move 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.Move 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.Move 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.Move 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 instance to move. Values are of the form `projects//instances/`.
-
setName
public Spanner.Projects.Instances.Move setName(String name)
Required. The instance to move. Values are of the form `projects//instances/`.
-
set
public Spanner.Projects.Instances.Move set(String parameterName,
Object value)
- Overrides:
set in class SpannerRequest<Operation>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy