Reference documentation and code samples for the Cloud Firestore V1beta1 Client class ExistenceFilter.
A digest of all the documents that match a given target.
Generated from protobuf message google.firestore.v1beta1.ExistenceFilter
Namespace
Google \ Cloud \ Firestore \ V1beta1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ target_id
int
The target ID to which this filter applies.
↳ count
int
The total count of documents that match target_id. If different from the count of documents in the client that match, the client must manually determine which documents no longer match the target.
getTargetId
The target ID to which this filter applies.
Returns
Type
Description
int
setTargetId
The target ID to which this filter applies.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getCount
The total count of documents that match target_id.
If different from the count of documents in the client that match, the
client must manually determine which documents no longer match the target.
Returns
Type
Description
int
setCount
The total count of documents that match target_id.
If different from the count of documents in the client that match, the
client must manually determine which documents no longer match the target.
[[["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 V1beta1 Client - Class ExistenceFilter (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/V1beta1.ExistenceFilter)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/V1beta1.ExistenceFilter)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/V1beta1.ExistenceFilter)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/V1beta1.ExistenceFilter)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/V1beta1.ExistenceFilter)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/V1beta1.ExistenceFilter)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/V1beta1.ExistenceFilter)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/V1beta1.ExistenceFilter)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/V1beta1.ExistenceFilter)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/V1beta1.ExistenceFilter)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/V1beta1.ExistenceFilter)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/V1beta1.ExistenceFilter)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/V1beta1.ExistenceFilter)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/V1beta1.ExistenceFilter)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/V1beta1.ExistenceFilter)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/V1beta1.ExistenceFilter)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/V1beta1.ExistenceFilter)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/V1beta1.ExistenceFilter)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/V1beta1.ExistenceFilter)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/V1beta1.ExistenceFilter)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/V1beta1.ExistenceFilter)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/V1beta1.ExistenceFilter)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/V1beta1.ExistenceFilter) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Cloud Firestore V1beta1 Client class ExistenceFilter.\n\nA digest of all the documents that match a given target.\n\nGenerated from protobuf message `google.firestore.v1beta1.ExistenceFilter`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ V1beta1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getTargetId\n\nThe target ID to which this filter applies.\n\n### setTargetId\n\nThe target ID to which this filter applies.\n\n### getCount\n\nThe total count of documents that match [target_id](/php/docs/reference/cloud-firestore/latest/V1beta1.ExistenceFilter#_Google_Cloud_Firestore_V1beta1_ExistenceFilter__getTargetId__).\n\nIf different from the count of documents in the client that match, the\nclient must manually determine which documents no longer match the target.\n\n### setCount\n\nThe total count of documents that match [target_id](/php/docs/reference/cloud-firestore/latest/V1beta1.ExistenceFilter#_Google_Cloud_Firestore_V1beta1_ExistenceFilter__getTargetId__).\n\nIf different from the count of documents in the client that match, the\nclient must manually determine which documents no longer match the target."]]