Cloud Firestore V1 Client - Class DocumentRemove (1.31.0)

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

A Document has been removed from the view of the targets.

Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document. Multiple DocumentRemove messages may be returned for the same logical write or delete, if multiple targets are affected.

Generated from protobuf message google.firestore.v1.DocumentRemove

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ document string

The resource name of the Document that has gone out of view.

↳ removed_target_ids array

A set of target IDs for targets that previously matched this document.

↳ read_time Google\Protobuf\Timestamp

The read timestamp at which the remove was observed. Greater or equal to the commit_time of the change/delete/remove.

getDocument

The resource name of the Document that has gone out of view.

Returns
TypeDescription
string

setDocument

The resource name of the Document that has gone out of view.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRemovedTargetIds

A set of target IDs for targets that previously matched this document.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setRemovedTargetIds

A set of target IDs for targets that previously matched this document.

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this

getReadTime

The read timestamp at which the remove was observed.

Greater or equal to the commit_time of the change/delete/remove.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasReadTime

clearReadTime

setReadTime

The read timestamp at which the remove was observed.

Greater or equal to the commit_time of the change/delete/remove.

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