Package com.google.firestore.v1

Interface ExistenceFilterOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ExistenceFilter, ExistenceFilter.Builder
public interface ExistenceFilterOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getCount()
    The total count of documents that match [target_id][google.firestore.v1.ExistenceFilter.target_id].
    int
    getTargetId()
    The target ID to which this filter applies.
    BloomFilter
    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][google.firestore.v1.ExistenceFilter.target_id], in the form `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    BloomFilterOrBuilder
    getUnchangedNamesOrBuilder()
    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][google.firestore.v1.ExistenceFilter.target_id], in the form `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    boolean
    hasUnchangedNames()
    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][google.firestore.v1.ExistenceFilter.target_id], in the form `projects/{project_id}/databases/{database_id}/documents/{document_path}`.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getTargetId

      int getTargetId()
       The target ID to which this filter applies.
      int32 target_id = 1;
      Returns:
      The targetId.

    • getCount

      int getCount()
       The total count of documents that match
 [target_id][google.firestore.v1.ExistenceFilter.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.
      int32 count = 2;
      Returns:
      The count.

    • hasUnchangedNames

      boolean hasUnchangedNames()
       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][google.firestore.v1.ExistenceFilter.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.firestore.v1.BloomFilter unchanged_names = 3;
      Returns:
      Whether the unchangedNames field is set.

    • getUnchangedNames

      BloomFilter 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][google.firestore.v1.ExistenceFilter.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.firestore.v1.BloomFilter unchanged_names = 3;
      Returns:
      The unchangedNames.

    • getUnchangedNamesOrBuilder

      BloomFilterOrBuilder getUnchangedNamesOrBuilder()
       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][google.firestore.v1.ExistenceFilter.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.firestore.v1.BloomFilter unchanged_names = 3;