public static final class ExistenceFilter.Builder extends GeneratedMessageV3.Builder<ExistenceFilter.Builder> implements ExistenceFilterOrBuilderA digest of all the documents that match a given target.
Protobuf type google.firestore.v1.ExistenceFilter
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExistenceFilter.BuilderImplements
ExistenceFilterOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExistenceFilter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExistenceFilter.Builder |
|
build()
public ExistenceFilter build()| Returns | |
|---|---|
| Type | Description |
ExistenceFilter |
|
buildPartial()
public ExistenceFilter buildPartial()| Returns | |
|---|---|
| Type | Description |
ExistenceFilter |
|
clear()
public ExistenceFilter.Builder clear()| Returns | |
|---|---|
| Type | Description |
ExistenceFilter.Builder |
|
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 | |
|---|---|
| Type | Description |
ExistenceFilter.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ExistenceFilter.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExistenceFilter.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public ExistenceFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExistenceFilter.Builder |
|
clearTargetId()
public ExistenceFilter.Builder clearTargetId()The target ID to which this filter applies.
int32 target_id = 1;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ExistenceFilter.Builder |
|
clone()
public ExistenceFilter.Builder clone()| Returns | |
|---|---|
| Type | Description |
ExistenceFilter.Builder |
|
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 | |
|---|---|
| Type | Description |
int |
The count. |
getDefaultInstanceForType()
public ExistenceFilter getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ExistenceFilter |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getTargetId()
public int 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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
Whether the unchangedNames field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ExistenceFilter other)
public ExistenceFilter.Builder mergeFrom(ExistenceFilter other)| Parameter | |
|---|---|
| Name | Description |
other |
ExistenceFilter |
| Returns | |
|---|---|
| Type | Description |
ExistenceFilter.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExistenceFilter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ExistenceFilter.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ExistenceFilter.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ExistenceFilter.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
BloomFilter |
| Returns | |
|---|---|
| Type | Description |
ExistenceFilter.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExistenceFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExistenceFilter.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
intThe count to set. |
| Returns | |
|---|---|
| Type | Description |
ExistenceFilter.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ExistenceFilter.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExistenceFilter.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExistenceFilter.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExistenceFilter.Builder |
|
setTargetId(int value)
public ExistenceFilter.Builder setTargetId(int value)The target ID to which this filter applies.
int32 target_id = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe targetId to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
BloomFilter |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
BloomFilter.Builder |
| Returns | |
|---|---|
| Type | Description |
ExistenceFilter.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ExistenceFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExistenceFilter.Builder |
|