Class ProjectsResource.InstancesResource.MoveRequest
Moves an instance to the target instance configuration. You can use the returned long-running operation
to track the progress of moving the instance. MoveInstance
returns FAILED_PRECONDITION
if the
instance meets any of the following criteria: * Is undergoing a move to a different instance
configuration * Has backups * Has an ongoing update * Contains any CMEK-enabled databases * Is a free
trial instance 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 might experience higher
read-write latencies and a higher transaction abort rate. However, moving an instance doesn't cause any
downtime. The returned long-running operation has 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 because it involves moving any data previously moved to the target instance
configuration back to the original instance configuration. You can use this operation to track the
progress of the cancellation. Upon successful completion of the cancellation, the operation terminates
with CANCELLED
status. If not cancelled, upon completion of the returned operation: * The instance
successfully moves to the target instance configuration. * You are billed for compute and storage in
target instance configuration. Authorization requires the spanner.instances.update
permission on the
resource instance. For more details, see Move an
instance.
Inheritance
Inherited Members
Namespace: Google.Apis.Spanner.v1
Assembly: Google.Apis.Spanner.v1.dll
Syntax
public class ProjectsResource.InstancesResource.MoveRequest : SpannerBaseServiceRequest<Operation>, IClientServiceRequest<Operation>, IClientServiceRequest
Constructors
MoveRequest(IClientService, MoveInstanceRequest, string)
Constructs a new Move request.
Declaration
public MoveRequest(IClientService service, MoveInstanceRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
MoveInstanceRequest | body | |
string | name |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Name
Required. The instance to move. Values are of the form projects//instances/
.
Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Methods
GetBody()
Returns the body of the request.
Declaration
protected override object GetBody()
Returns
Type | Description |
---|---|
object |
Overrides
InitParameters()
Initializes Move parameter list.
Declaration
protected override void InitParameters()