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
Namespace
Google \ Cloud \ Firestore \ V1
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
array
A set of target IDs for targets that previously matched this document.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class DocumentRemove (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/V1.DocumentRemove)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/V1.DocumentRemove)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/V1.DocumentRemove)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/V1.DocumentRemove)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/V1.DocumentRemove)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/V1.DocumentRemove)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/V1.DocumentRemove)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/V1.DocumentRemove)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/V1.DocumentRemove)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/V1.DocumentRemove)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/V1.DocumentRemove)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/V1.DocumentRemove)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/V1.DocumentRemove)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/V1.DocumentRemove)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/V1.DocumentRemove)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/V1.DocumentRemove)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/V1.DocumentRemove)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/V1.DocumentRemove)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/V1.DocumentRemove)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/V1.DocumentRemove)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/V1.DocumentRemove)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/V1.DocumentRemove)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/V1.DocumentRemove) \nReference documentation and code samples for the Cloud Firestore V1 Client class DocumentRemove.\n\nA [Document](/php/docs/reference/cloud-firestore/latest/V1.Document) has been removed from the view of\nthe targets.\n\nSent if the document is no longer relevant to a target and is out of view.\nCan be sent instead of a DocumentDelete or a DocumentChange if the server\ncan not send the new value of the document.\nMultiple [DocumentRemove](/php/docs/reference/cloud-firestore/latest/V1.DocumentRemove) messages may be\nreturned for the same logical write or delete, if multiple targets are\naffected.\n\nGenerated from protobuf message `google.firestore.v1.DocumentRemove`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDocument\n\nThe resource name of the [Document](/php/docs/reference/cloud-firestore/latest/V1.Document) that has\ngone out of view.\n\n### setDocument\n\nThe resource name of the [Document](/php/docs/reference/cloud-firestore/latest/V1.Document) that has\ngone out of view.\n\n### getRemovedTargetIds\n\nA set of target IDs for targets that previously matched this document.\n\n### setRemovedTargetIds\n\nA set of target IDs for targets that previously matched this document.\n\n### getReadTime\n\nThe read timestamp at which the remove was observed.\n\nGreater or equal to the `commit_time` of the change/delete/remove.\n\n### hasReadTime\n\n### clearReadTime\n\n### setReadTime\n\nThe read timestamp at which the remove was observed.\n\nGreater or equal to the `commit_time` of the change/delete/remove."]]
