Package com.google.firestore.v1

Class ExistenceFilter.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ExistenceFilter.Builder>
com.google.firestore.v1.ExistenceFilter.Builder
All Implemented Interfaces:
ExistenceFilterOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ExistenceFilter
public static final class ExistenceFilter.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ExistenceFilter.Builder> implements ExistenceFilterOrBuilder
 A digest of all the documents that match a given target.
Protobuf type google.firestore.v1.ExistenceFilter

  • Method Summary

    Modifier and Type
    Method
    Description
    ExistenceFilter.Builder
    addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    ExistenceFilter
    build()
     
    ExistenceFilter
    buildPartial()
     
    ExistenceFilter.Builder
    clear()
     
    ExistenceFilter.Builder
    clearCount()
    The total count of documents that match [target_id][google.firestore.v1.ExistenceFilter.target_id].
    ExistenceFilter.Builder
    clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
     
    ExistenceFilter.Builder
    clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
     
    ExistenceFilter.Builder
    clearTargetId()
    The target ID to which this filter applies.
    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][google.firestore.v1.ExistenceFilter.target_id], in the form `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    ExistenceFilter.Builder
    clone()
     
    int
    getCount()
    The total count of documents that match [target_id][google.firestore.v1.ExistenceFilter.target_id].
    ExistenceFilter
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    int
    getTargetId()
    The target ID to which this filter applies.
    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][google.firestore.v1.ExistenceFilter.target_id], in the form `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    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][google.firestore.v1.ExistenceFilter.target_id], in the form `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    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][google.firestore.v1.ExistenceFilter.target_id], in the form `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    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][google.firestore.v1.ExistenceFilter.target_id], in the form `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    ExistenceFilter.Builder
    mergeFrom(ExistenceFilter other)
     
    ExistenceFilter.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    ExistenceFilter.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    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][google.firestore.v1.ExistenceFilter.target_id], in the form `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    final ExistenceFilter.Builder
    mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     
    ExistenceFilter.Builder
    setCount(int value)
    The total count of documents that match [target_id][google.firestore.v1.ExistenceFilter.target_id].
    ExistenceFilter.Builder
    setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    ExistenceFilter.Builder
    setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
     
    ExistenceFilter.Builder
    setTargetId(int value)
    The target ID to which this filter applies.
    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][google.firestore.v1.ExistenceFilter.target_id], in the form `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    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][google.firestore.v1.ExistenceFilter.target_id], in the form `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    final ExistenceFilter.Builder
    setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

    getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ExistenceFilter.Builder>

    • clear

      public ExistenceFilter.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<ExistenceFilter.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ExistenceFilter.Builder>

    • getDefaultInstanceForType

      public ExistenceFilter getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public ExistenceFilter build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ExistenceFilter buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public ExistenceFilter.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<ExistenceFilter.Builder>

    • setField

      public ExistenceFilter.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<ExistenceFilter.Builder>

    • clearField

      public ExistenceFilter.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ExistenceFilter.Builder>

    • clearOneof

      public ExistenceFilter.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ExistenceFilter.Builder>

    • setRepeatedField

      public ExistenceFilter.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExistenceFilter.Builder>

    • addRepeatedField

      public ExistenceFilter.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExistenceFilter.Builder>

    • mergeFrom

      public ExistenceFilter.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExistenceFilter.Builder>

    • mergeFrom

      public ExistenceFilter.Builder mergeFrom(ExistenceFilter other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ExistenceFilter.Builder>

    • mergeFrom

      public ExistenceFilter.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExistenceFilter.Builder>
      Throws:
      IOException

    • getTargetId

      public int getTargetId()
       The target ID to which this filter applies.
      int32 target_id = 1;
      Specified by:
      getTargetId in interface ExistenceFilterOrBuilder
      Returns:
      The targetId.

    • setTargetId

      public ExistenceFilter.Builder setTargetId(int value)
       The target ID to which this filter applies.
      int32 target_id = 1;
      Parameters:
      value - The targetId to set.
      Returns:
      This builder for chaining.

    • clearTargetId

      public ExistenceFilter.Builder clearTargetId()
       The target ID to which this filter applies.
      int32 target_id = 1;
      Returns:
      This builder for chaining.

    • getCount

      public int getCount()
       The total count of documents that match
 [target_id][google.firestore.v1.ExistenceFilter.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;
      Specified by:
      getCount in interface ExistenceFilterOrBuilder
      Returns:
      The count.

    • setCount

      public ExistenceFilter.Builder setCount(int value)
       The total count of documents that match
 [target_id][google.firestore.v1.ExistenceFilter.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;
      Parameters:
      value - The count to set.
      Returns:
      This builder for chaining.

    • clearCount

      public ExistenceFilter.Builder clearCount()
       The total count of documents that match
 [target_id][google.firestore.v1.ExistenceFilter.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:
      This builder for chaining.

    • 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][google.firestore.v1.ExistenceFilter.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;
      Specified by:
      hasUnchangedNames in interface ExistenceFilterOrBuilder
      Returns:
      Whether the unchangedNames field is set.

    • 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][google.firestore.v1.ExistenceFilter.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;
      Specified by:
      getUnchangedNames in interface ExistenceFilterOrBuilder
      Returns:
      The unchangedNames.

    • setUnchangedNames

      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][google.firestore.v1.ExistenceFilter.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;

    • setUnchangedNames

      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][google.firestore.v1.ExistenceFilter.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;

    • mergeUnchangedNames

      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][google.firestore.v1.ExistenceFilter.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;

    • 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][google.firestore.v1.ExistenceFilter.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;

    • 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][google.firestore.v1.ExistenceFilter.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;

    • 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][google.firestore.v1.ExistenceFilter.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;
      Specified by:
      getUnchangedNamesOrBuilder in interface ExistenceFilterOrBuilder

    • setUnknownFields

      public final ExistenceFilter.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExistenceFilter.Builder>

    • mergeUnknownFields

      public final ExistenceFilter.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExistenceFilter.Builder>