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 and 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 contains the UTF-8 byte encodings of the resource names of the documents that match [target_id][google.firestore.v1.ExistenceFilter.target_id], in the form `projects/{project_id}/databases/{database_id}/documents/{document_path}` that have NOT changed since the query results indicated by the resume token or timestamp given in `Target.resume_type`.
BloomFilterOrBuilder	getUnchangedNamesOrBuilder() A bloom filter that contains the UTF-8 byte encodings of the resource names of the documents that match [target_id][google.firestore.v1.ExistenceFilter.target_id], in the form `projects/{project_id}/databases/{database_id}/documents/{document_path}` that have NOT changed since the query results indicated by the resume token or timestamp given in `Target.resume_type`.
boolean	hasUnchangedNames() A bloom filter that contains the UTF-8 byte encodings of the resource names of the documents that match [target_id][google.firestore.v1.ExistenceFilter.target_id], in the form `projects/{project_id}/databases/{database_id}/documents/{document_path}` that have NOT changed since the query results indicated by the resume token or timestamp given in `Target.resume_type`.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

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.
 

int32 count = 2;

Returns:

The count.

hasUnchangedNames

boolean hasUnchangedNames()

 A bloom filter that contains the UTF-8 byte encodings of the resource names
 of the documents that match
 [target_id][google.firestore.v1.ExistenceFilter.target_id], in the form
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`
 that have NOT changed since the query results indicated by the resume token
 or timestamp given in `Target.resume_type`.
 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 contains the UTF-8 byte encodings of the resource names
 of the documents that match
 [target_id][google.firestore.v1.ExistenceFilter.target_id], in the form
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`
 that have NOT changed since the query results indicated by the resume token
 or timestamp given in `Target.resume_type`.
 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 contains the UTF-8 byte encodings of the resource names
 of the documents that match
 [target_id][google.firestore.v1.ExistenceFilter.target_id], in the form
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`
 that have NOT changed since the query results indicated by the resume token
 or timestamp given in `Target.resume_type`.
 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;