Cloud Spanner V1 Client - Class MoveInstanceMetadata (1.89.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class MoveInstanceMetadata.

Metadata type for the operation returned by MoveInstance.

Generated from protobuf message google.spanner.admin.instance.v1.MoveInstanceMetadata

Namespace

Google \ Cloud \ Spanner \ Admin \ Instance \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ target_config string

The target instance configuration where to move the instance. Values are of the form projects/<project>/instanceConfigs/<config>.
↳ progress Google\Cloud\Spanner\Admin\Instance\V1\OperationProgress

The progress of the MoveInstance operation. progress_percent is reset when cancellation is requested.
↳ cancel_time Google\Protobuf\Timestamp

The time at which this operation was cancelled.

getTargetConfig

The target instance configuration where to move the instance.

Values are of the form projects/<project>/instanceConfigs/<config>.

Returns
Type Description
string

setTargetConfig

The target instance configuration where to move the instance.

Values are of the form projects/<project>/instanceConfigs/<config>.

Parameter
Name Description
var string
Returns
Type Description
$this

getProgress

The progress of the MoveInstance operation.

progress_percent is reset when cancellation is requested.

Returns
Type Description
Google\Cloud\Spanner\Admin\Instance\V1\OperationProgress|null

hasProgress

clearProgress

setProgress

The progress of the MoveInstance operation.

progress_percent is reset when cancellation is requested.

Parameter
Name Description
var Google\Cloud\Spanner\Admin\Instance\V1\OperationProgress
Returns
Type Description
$this

getCancelTime

The time at which this operation was cancelled.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCancelTime

clearCancelTime

setCancelTime

The time at which this operation was cancelled.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this