Cloud Firestore V1beta1 Client - Class DocumentRemove (1.27.3)

Version 1.27.3

• 1.47.1 (latest)
• 1.47.0
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Cloud Firestore V1beta1 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.v1beta1.DocumentRemove

Methods

__construct

Constructor.

Parameters
Name	Description
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	int[] 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
Type	Description
string

setDocument

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getRemovedTargetIds

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

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setRemovedTargetIds

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

Parameter
Name	Description
var	int[]

Returns
Type	Description
$this

getReadTime

The read timestamp at which the remove was observed.

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

Returns
Type	Description
Google\Protobuf\Timestamp

setReadTime

The read timestamp at which the remove was observed.

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

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this