Class ExistenceFilter.Builder (3.17.0)

public static final class ExistenceFilter.Builder extends GeneratedMessageV3.Builder<ExistenceFilter.Builder> implements ExistenceFilterOrBuilder

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

Protobuf type google.firestore.v1.ExistenceFilter

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExistenceFilter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExistenceFilter.Builder
Overrides

build()

public ExistenceFilter build()
Returns
TypeDescription
ExistenceFilter

buildPartial()

public ExistenceFilter buildPartial()
Returns
TypeDescription
ExistenceFilter

clear()

public ExistenceFilter.Builder clear()
Returns
TypeDescription
ExistenceFilter.Builder
Overrides

clearCount()

public ExistenceFilter.Builder clearCount()

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
TypeDescription
ExistenceFilter.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ExistenceFilter.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ExistenceFilter.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ExistenceFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ExistenceFilter.Builder
Overrides

clearTargetId()

public ExistenceFilter.Builder clearTargetId()

The target ID to which this filter applies.

int32 target_id = 1;

Returns
TypeDescription
ExistenceFilter.Builder

This builder for chaining.

clearUnchangedNames()

public ExistenceFilter.Builder clearUnchangedNames()

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
TypeDescription
ExistenceFilter.Builder

clone()

public ExistenceFilter.Builder clone()
Returns
TypeDescription
ExistenceFilter.Builder
Overrides

getCount()

public 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
TypeDescription
int

The count.

getDefaultInstanceForType()

public ExistenceFilter getDefaultInstanceForType()
Returns
TypeDescription
ExistenceFilter

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getTargetId()

public int getTargetId()

The target ID to which this filter applies.

int32 target_id = 1;

Returns
TypeDescription
int

The targetId.

getUnchangedNames()

public 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
TypeDescription
BloomFilter

The unchangedNames.

getUnchangedNamesBuilder()

public BloomFilter.Builder getUnchangedNamesBuilder()

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
TypeDescription
BloomFilter.Builder

getUnchangedNamesOrBuilder()

public 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
TypeDescription
BloomFilterOrBuilder

hasUnchangedNames()

public 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
TypeDescription
boolean

Whether the unchangedNames field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ExistenceFilter other)

public ExistenceFilter.Builder mergeFrom(ExistenceFilter other)
Parameter
NameDescription
otherExistenceFilter
Returns
TypeDescription
ExistenceFilter.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExistenceFilter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExistenceFilter.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ExistenceFilter.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ExistenceFilter.Builder
Overrides

mergeUnchangedNames(BloomFilter value)

public ExistenceFilter.Builder mergeUnchangedNames(BloomFilter value)

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;

Parameter
NameDescription
valueBloomFilter
Returns
TypeDescription
ExistenceFilter.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExistenceFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExistenceFilter.Builder
Overrides

setCount(int value)

public ExistenceFilter.Builder setCount(int value)

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;

Parameter
NameDescription
valueint

The count to set.

Returns
TypeDescription
ExistenceFilter.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ExistenceFilter.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExistenceFilter.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ExistenceFilter.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ExistenceFilter.Builder
Overrides

setTargetId(int value)

public ExistenceFilter.Builder setTargetId(int value)

The target ID to which this filter applies.

int32 target_id = 1;

Parameter
NameDescription
valueint

The targetId to set.

Returns
TypeDescription
ExistenceFilter.Builder

This builder for chaining.

setUnchangedNames(BloomFilter value)

public ExistenceFilter.Builder setUnchangedNames(BloomFilter value)

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;

Parameter
NameDescription
valueBloomFilter
Returns
TypeDescription
ExistenceFilter.Builder

setUnchangedNames(BloomFilter.Builder builderForValue)

public ExistenceFilter.Builder setUnchangedNames(BloomFilter.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBloomFilter.Builder
Returns
TypeDescription
ExistenceFilter.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ExistenceFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExistenceFilter.Builder
Overrides