Cloud Spanner V1 Client - Class UpdateInstanceMetadata (1.91.0)

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

Namespace

Google \ Cloud \ Spanner \ Admin \ Instance \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ instance 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.

↳ expected_fulfillment_period int

The expected fulfillment period of this update operation.

getInstance

The desired end state of the update.

Returns
Type Description
Instance|null

hasInstance

clearInstance

setInstance

The desired end state of the update.

Parameter
Name Description
var Instance
Returns
Type Description
$this

getStartTime

The time at which UpdateInstance request was received.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

The time at which UpdateInstance request was received.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$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.

Returns
Type Description
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.

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

getEndTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

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

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

getExpectedFulfillmentPeriod

The expected fulfillment period of this update operation.

Returns
Type Description
int

setExpectedFulfillmentPeriod

The expected fulfillment period of this update operation.

Parameter
Name Description
var int
Returns
Type Description
$this