Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::ExistenceFilter.
A digest of all the documents that match a given target.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#count
def count() -> ::Integer-
(::Integer) — 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_namesbloom 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.
#count=
def count=(value) -> ::Integer-
value (::Integer) — 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_namesbloom 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.
-
(::Integer) — 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_namesbloom 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.
#target_id
def target_id() -> ::Integer- (::Integer) — The target ID to which this filter applies.
#target_id=
def target_id=(value) -> ::Integer- value (::Integer) — The target ID to which this filter applies.
- (::Integer) — The target ID to which this filter applies.
#unchanged_names
def unchanged_names() -> ::Google::Cloud::Firestore::V1::BloomFilter-
(::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.
#unchanged_names=
def unchanged_names=(value) -> ::Google::Cloud::Firestore::V1::BloomFilter-
value (::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.
-
(::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.