Class ExistenceFilter (3.17.0)

public final class ExistenceFilter extends GeneratedMessageV3 implements ExistenceFilterOrBuilder

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

Protobuf type google.firestore.v1.ExistenceFilter

Static Fields

COUNT_FIELD_NUMBER

public static final int COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

TARGET_ID_FIELD_NUMBER

public static final int TARGET_ID_FIELD_NUMBER
Field Value
TypeDescription
int

UNCHANGED_NAMES_FIELD_NUMBER

public static final int UNCHANGED_NAMES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExistenceFilter getDefaultInstance()
Returns
TypeDescription
ExistenceFilter

getDescriptor()

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

newBuilder()

public static ExistenceFilter.Builder newBuilder()
Returns
TypeDescription
ExistenceFilter.Builder

newBuilder(ExistenceFilter prototype)

public static ExistenceFilter.Builder newBuilder(ExistenceFilter prototype)
Parameter
NameDescription
prototypeExistenceFilter
Returns
TypeDescription
ExistenceFilter.Builder

parseDelimitedFrom(InputStream input)

public static ExistenceFilter parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExistenceFilter
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExistenceFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExistenceFilter
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ExistenceFilter parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ExistenceFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExistenceFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExistenceFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExistenceFilter parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ExistenceFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExistenceFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExistenceFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExistenceFilter parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ExistenceFilter
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExistenceFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExistenceFilter
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ExistenceFilter parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExistenceFilter
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExistenceFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExistenceFilter
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ExistenceFilter parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ExistenceFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExistenceFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExistenceFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ExistenceFilter> parser()
Returns
TypeDescription
Parser<ExistenceFilter>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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

getParserForType()

public Parser<ExistenceFilter> getParserForType()
Returns
TypeDescription
Parser<ExistenceFilter>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
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.

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ExistenceFilter.Builder newBuilderForType()
Returns
TypeDescription
ExistenceFilter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExistenceFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ExistenceFilter.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ExistenceFilter.Builder toBuilder()
Returns
TypeDescription
ExistenceFilter.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException