Cloud Spanner V1 Client - Class OperationProgress (1.54.2)

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

Encapsulates progress related information for a Cloud Spanner long running operation.

Generated from protobuf message google.spanner.admin.database.v1.OperationProgress

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ progress_percent int

Percent completion of the operation. Values are between 0 and 100 inclusive.

↳ start_time Google\Protobuf\Timestamp

Time the request was received.

↳ end_time Google\Protobuf\Timestamp

If set, the time at which this operation failed or was completed successfully.

getProgressPercent

Percent completion of the operation.

Values are between 0 and 100 inclusive.

Generated from protobuf field int32 progress_percent = 1;

Returns
TypeDescription
int

setProgressPercent

Percent completion of the operation.

Values are between 0 and 100 inclusive.

Generated from protobuf field int32 progress_percent = 1;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getStartTime

Time the request was received.

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Time the request was received.

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

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

getEndTime

If set, the time at which this operation failed or was completed successfully.

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

If set, the time at which this operation failed or was completed successfully.

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

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