Interface ExistenceFilterOrBuilder (3.24.3)

Version 3.24.3

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public interface ExistenceFilterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCount()

public abstract int 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.

int32 count = 2;

Returns
Type	Description
int	The count.

getTargetId()

public abstract int getTargetId()

The target ID to which this filter applies.

int32 target_id = 1;

Returns
Type	Description
int	The targetId.

getUnchangedNames()

public abstract 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, 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
Type	Description
BloomFilter	The unchangedNames.

getUnchangedNamesOrBuilder()

public abstract 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, 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
Type	Description
BloomFilterOrBuilder

hasUnchangedNames()

public abstract 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, 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
Type	Description
boolean	Whether the unchangedNames field is set.