Reference documentation and code samples for the Cloud Firestore V1 Client class ExistenceFilter.
A digest of all the documents that match a given target.
Generated from protobuf message google.firestore.v1.ExistenceFilter
Namespace
Google \ Cloud \ Firestore \ V1Methods
__construct
Constructor.
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. The client can use the unchanged_names
bloom filter to assist with this determination by testing ALL the document names against the filter; if the document name is NOT in the filter, it means the document no longer matches the target.
↳ unchanged_names
Google\Cloud\Firestore\V1\BloomFilter
A bloom filter that, despite its name, contains the UTF-8 byte encodings of the resource names of ALL the documents that match target_id
, in the form projects/{project_id}/databases/{database_id}/documents/{document_path}
. This bloom filter may be omitted at the server's discretion, such as if it is deemed that the client will not make use of it or if it is too computationally expensive to calculate or transmit. Clients must gracefully handle this field being absent by falling back to the logic used before this field existed; that is, re-add the target without a resume token to figure out which documents in the client's cache are out of sync.
getTargetId
The target ID to which this filter applies.
int
setTargetId
The target ID to which this filter applies.
var
int
$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.
The client can use the unchanged_names
bloom filter to assist with
this determination by testing ALL the document names against the filter;
if the document name is NOT in the filter, it means the document no
longer matches the target.
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.
The client can use the unchanged_names
bloom filter to assist with
this determination by testing ALL the document names against the filter;
if the document name is NOT in the filter, it means the document no
longer matches the target.
var
int
$this
getUnchangedNames
A bloom filter that, despite its name, contains the UTF-8 byte encodings of
the resource names of ALL the documents that match target_id
, in the form projects/{project_id}/databases/{database_id}/documents/{document_path}
.
This bloom filter may be omitted at the server's discretion, such as if it is deemed that the client will not make use of it or if it is too computationally expensive to calculate or transmit. Clients must gracefully handle this field being absent by falling back to the logic used before this field existed; that is, re-add the target without a resume token to figure out which documents in the client's cache are out of sync.
hasUnchangedNames
clearUnchangedNames
setUnchangedNames
A bloom filter that, despite its name, contains the UTF-8 byte encodings of
the resource names of ALL the documents that match target_id
, in the form projects/{project_id}/databases/{database_id}/documents/{document_path}
.
This bloom filter may be omitted at the server's discretion, such as if it is deemed that the client will not make use of it or if it is too computationally expensive to calculate or transmit. Clients must gracefully handle this field being absent by falling back to the logic used before this field existed; that is, re-add the target without a resume token to figure out which documents in the client's cache are out of sync.
$this
