Cloud Firestore V1 Client - Class Progress (1.28.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class Progress.

Describes the progress of the operation.

Unit of work is generic and must be interpreted based on where Progress is used.

Generated from protobuf message google.firestore.admin.v1.Progress

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ estimated_work int|string

The amount of work estimated.

↳ completed_work int|string

The amount of work completed.

getEstimatedWork

The amount of work estimated.

Returns
TypeDescription
int|string

setEstimatedWork

The amount of work estimated.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getCompletedWork

The amount of work completed.

Returns
TypeDescription
int|string

setCompletedWork

The amount of work completed.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this