Cloud Firestore V1 Client - Class DocumentDelete (1.31.0)

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

A Document has been deleted.

May be the result of multiple writes, including updates, the last of which deleted the Document. Multiple DocumentDelete messages may be returned for the same logical delete, if multiple targets are affected.

Generated from protobuf message google.firestore.v1.DocumentDelete

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ document string

The resource name of the Document that was deleted.

↳ removed_target_ids array

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

↳ read_time Google\Protobuf\Timestamp

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

getDocument

The resource name of the Document that was deleted.

Returns
TypeDescription
string

setDocument

The resource name of the Document that was deleted.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRemovedTargetIds

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setRemovedTargetIds

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

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this

getReadTime

The read timestamp at which the delete was observed.

Greater or equal to the commit_time of the delete.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasReadTime

clearReadTime

setReadTime

The read timestamp at which the delete was observed.

Greater or equal to the commit_time of the delete.

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