Cloud Spanner V1 Client - Class UpdateInstanceMetadata (1.54.2)

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

Metadata type for the operation returned by UpdateInstance.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ instance Google\Cloud\Spanner\Admin\Instance\V1\Instance

The desired end state of the update.

↳ start_time Google\Protobuf\Timestamp

The time at which UpdateInstance request was received.

↳ cancel_time Google\Protobuf\Timestamp

The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.

↳ end_time Google\Protobuf\Timestamp

The time at which this operation failed or was completed successfully.

getInstance

The desired end state of the update.

Generated from protobuf field .google.spanner.admin.instance.v1.Instance instance = 1;

Returns
TypeDescription
Google\Cloud\Spanner\Admin\Instance\V1\Instance|null

hasInstance

clearInstance

setInstance

The desired end state of the update.

Generated from protobuf field .google.spanner.admin.instance.v1.Instance instance = 1;

Parameter
NameDescription
var Google\Cloud\Spanner\Admin\Instance\V1\Instance
Returns
TypeDescription
$this

getStartTime

The time at which UpdateInstance request was received.

Generated from protobuf field .google.protobuf.Timestamp start_time = 2;

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

The time at which UpdateInstance request was received.

Generated from protobuf field .google.protobuf.Timestamp start_time = 2;

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getCancelTime

The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.

Generated from protobuf field .google.protobuf.Timestamp cancel_time = 3;

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCancelTime

clearCancelTime

setCancelTime

The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.

Generated from protobuf field .google.protobuf.Timestamp cancel_time = 3;

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEndTime

The time at which this operation failed or was completed successfully.

Generated from protobuf field .google.protobuf.Timestamp end_time = 4;

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

The time at which this operation failed or was completed successfully.

Generated from protobuf field .google.protobuf.Timestamp end_time = 4;

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this