Firestore v1 API - Class ExistenceFilter (3.9.0)

public sealed class ExistenceFilter : IMessage<ExistenceFilter>, IEquatable<ExistenceFilter>, IDeepCloneable<ExistenceFilter>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore v1 API class ExistenceFilter.

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

Inheritance

object > ExistenceFilter

Implements

IMessage ExistenceFilter, IEquatable ExistenceFilter, IDeepCloneable ExistenceFilter, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

ExistenceFilter()

public ExistenceFilter()

ExistenceFilter(ExistenceFilter)

public ExistenceFilter(ExistenceFilter other)

Parameter
Name	Description
`other`	`ExistenceFilter`

Properties

Count

public int Count { get; set; }

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.

Property Value
Type	Description
`int`

TargetId

public int TargetId { get; set; }

The target ID to which this filter applies.

Property Value
Type	Description
`int`

UnchangedNames

public BloomFilter UnchangedNames { get; set; }

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.

Property Value
Type	Description
`BloomFilter`