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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
COUNT_FIELD_NUMBER
public static final int COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TARGET_ID_FIELD_NUMBER
public static final int TARGET_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UNCHANGED_NAMES_FIELD_NUMBER
public static final int UNCHANGED_NAMES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ExistenceFilter getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ExistenceFilter.Builder newBuilder()
newBuilder(ExistenceFilter prototype)
public static ExistenceFilter.Builder newBuilder(ExistenceFilter prototype)
public static ExistenceFilter parseDelimitedFrom(InputStream input)
public static ExistenceFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ExistenceFilter parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExistenceFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ExistenceFilter parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExistenceFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExistenceFilter parseFrom(CodedInputStream input)
public static ExistenceFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ExistenceFilter parseFrom(InputStream input)
public static ExistenceFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ExistenceFilter parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExistenceFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ExistenceFilter> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
getDefaultInstanceForType()
public ExistenceFilter getDefaultInstanceForType()
getParserForType()
public Parser<ExistenceFilter> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTargetId()
The target ID to which this filter applies.
int32 target_id = 1;
| Returns |
| Type |
Description |
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 |
| Type |
Description |
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;
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 |
| Type |
Description |
boolean |
Whether the unchangedNames field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ExistenceFilter.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExistenceFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ExistenceFilter.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
