Class: Google::Cloud::Firestore::V1::ExistenceFilter

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/v1/write.rb

Overview

A digest of all the documents that match a given target.

Instance Attribute Summary collapse

Instance Attribute Details

#count ⇒ ::Integer

Returns 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.

Returns:

  • (::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_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.



292
293
294
295
 
# File 'proto_docs/google/firestore/v1/write.rb', line 292

class ExistenceFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#target_id ⇒ ::Integer

Returns The target ID to which this filter applies.

Returns:

  • (::Integer) —

    The target ID to which this filter applies.



292
293
294
295
 
# File 'proto_docs/google/firestore/v1/write.rb', line 292

class ExistenceFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#unchanged_names ⇒ ::Google::Cloud::Firestore::V1::BloomFilter

Returns 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.

Returns:

  • (::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.



292
293
294
295
 
# File 'proto_docs/google/firestore/v1/write.rb', line 292

class ExistenceFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end