Cloud Firestore V1 Client - Class WriteResult (1.31.0)

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

The result of applying a write.

Generated from protobuf message google.firestore.v1.WriteResult

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ update_time Google\Protobuf\Timestamp

The last update time of the document after applying the write. Not set after a delete. If the write did not actually change the document, this will be the previous update_time.

↳ transform_results array<Google\Cloud\Firestore\V1\Value>

The results of applying each DocumentTransform.FieldTransform, in the same order.

getUpdateTime

The last update time of the document after applying the write. Not set after a delete.

If the write did not actually change the document, this will be the previous update_time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

The last update time of the document after applying the write. Not set after a delete.

If the write did not actually change the document, this will be the previous update_time.

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

getTransformResults

The results of applying each DocumentTransform.FieldTransform, in the same order.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTransformResults

The results of applying each DocumentTransform.FieldTransform, in the same order.

Parameter
NameDescription
var array<Google\Cloud\Firestore\V1\Value>
Returns
TypeDescription
$this