Struct google_firestore1_beta1::api::ExistenceFilter
source · pub struct ExistenceFilter {
pub count: Option<i32>,
pub target_id: Option<i32>,
pub unchanged_names: Option<BloomFilter>,
}
Expand description
A digest of all the documents that match a given target.
This type is not used in any activity, and only used as part of another schema.
Fields§
§count: Option<i32>
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.
target_id: Option<i32>
The target ID to which this filter applies.
unchanged_names: Option<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.
Trait Implementations§
source§impl Clone for ExistenceFilter
impl Clone for ExistenceFilter
source§fn clone(&self) -> ExistenceFilter
fn clone(&self) -> ExistenceFilter
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more