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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExistenceFilter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public ExistenceFilter build()
buildPartial()
public ExistenceFilter buildPartial()
clear()
public ExistenceFilter.Builder clear()
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.
int32 count = 2;
clearField(Descriptors.FieldDescriptor field)
public ExistenceFilter.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public ExistenceFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearTargetId()
public ExistenceFilter.Builder clearTargetId()
The target ID to which this filter applies.
int32 target_id = 1;
clearUnchangedNames()
public ExistenceFilter.Builder clearUnchangedNames()
A bloom filter that contains the UTF-8 byte encodings of the resource names
of the documents that match
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;
clone()
public ExistenceFilter.Builder clone()
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.
int32 count = 2;
| Returns |
|---|
| Type | Description |
int | The count.
|
getDefaultInstanceForType()
public ExistenceFilter getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
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 contains the UTF-8 byte encodings of the resource names
of the documents that match
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;
getUnchangedNamesBuilder()
public BloomFilter.Builder getUnchangedNamesBuilder()
A bloom filter that contains the UTF-8 byte encodings of the resource names
of the documents that match
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;
getUnchangedNamesOrBuilder()
public BloomFilterOrBuilder getUnchangedNamesOrBuilder()
A bloom filter that contains the UTF-8 byte encodings of the resource names
of the documents that match
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;
hasUnchangedNames()
public boolean hasUnchangedNames()
A bloom filter that contains the UTF-8 byte encodings of the resource names
of the documents that match
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 |
|---|
| Type | Description |
boolean | Whether the unchangedNames field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(ExistenceFilter other)
public ExistenceFilter.Builder mergeFrom(ExistenceFilter other)
public ExistenceFilter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public ExistenceFilter.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnchangedNames(BloomFilter value)
public ExistenceFilter.Builder mergeUnchangedNames(BloomFilter value)
A bloom filter that contains the UTF-8 byte encodings of the resource names
of the documents that match
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;
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExistenceFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
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.
int32 count = 2;
| Parameter |
|---|
| Name | Description |
value | int
The count to set.
|
setField(Descriptors.FieldDescriptor field, Object value)
public ExistenceFilter.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExistenceFilter.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
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 | int
The targetId to set.
|
setUnchangedNames(BloomFilter value)
public ExistenceFilter.Builder setUnchangedNames(BloomFilter value)
A bloom filter that contains the UTF-8 byte encodings of the resource names
of the documents that match
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;
setUnchangedNames(BloomFilter.Builder builderForValue)
public ExistenceFilter.Builder setUnchangedNames(BloomFilter.Builder builderForValue)
A bloom filter that contains the UTF-8 byte encodings of the resource names
of the documents that match
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;
setUnknownFields(UnknownFieldSet unknownFields)
public final ExistenceFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
