Package com.google.firestore.v1

Class BloomFilter.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<BloomFilter.Builder>
com.google.firestore.v1.BloomFilter.Builder
All Implemented Interfaces:
BloomFilterOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
BloomFilter
public static final class BloomFilter.Builder extends com.google.protobuf.GeneratedMessage.Builder<BloomFilter.Builder> implements BloomFilterOrBuilder
 A bloom filter (https://en.wikipedia.org/wiki/Bloom_filter).

 The bloom filter hashes the entries with MD5 and treats the resulting 128-bit
 hash as 2 distinct 64-bit hash values, interpreted as unsigned integers
 using 2's complement encoding.

 These two hash values, named `h1` and `h2`, are then used to compute the
 `hash_count` hash values using the formula, starting at `i=0`:

 h(i) = h1 + (i * h2)

 These resulting values are then taken modulo the number of bits in the bloom
 filter to get the bits of the bloom filter to test for the given entry.
Protobuf type google.firestore.v1.BloomFilter

  • Method Summary

    Modifier and Type
    Method
    Description
    BloomFilter
    build()
     
    BloomFilter
    buildPartial()
     
    BloomFilter.Builder
    clear()
     
    BloomFilter.Builder
    clearBits()
    The bloom filter data.
    BloomFilter.Builder
    clearHashCount()
    The number of hashes used by the algorithm.
    BitSequence
    getBits()
    The bloom filter data.
    BitSequence.Builder
    getBitsBuilder()
    The bloom filter data.
    BitSequenceOrBuilder
    getBitsOrBuilder()
    The bloom filter data.
    BloomFilter
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    int
    getHashCount()
    The number of hashes used by the algorithm.
    boolean
    hasBits()
    The bloom filter data.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    BloomFilter.Builder
    mergeBits(BitSequence value)
    The bloom filter data.
    BloomFilter.Builder
    mergeFrom(BloomFilter other)
     
    BloomFilter.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    BloomFilter.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    BloomFilter.Builder
    setBits(BitSequence value)
    The bloom filter data.
    BloomFilter.Builder
    setBits(BitSequence.Builder builderForValue)
    The bloom filter data.
    BloomFilter.Builder
    setHashCount(int value)
    The number of hashes used by the algorithm.

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

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<BloomFilter.Builder>

    • clear

      public BloomFilter.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.GeneratedMessage.Builder<BloomFilter.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.GeneratedMessage.Builder<BloomFilter.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public BloomFilter.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<BloomFilter.Builder>

    • mergeFrom

      public BloomFilter.Builder mergeFrom(BloomFilter other)

    • isInitialized

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

    • mergeFrom

      public BloomFilter.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<BloomFilter.Builder>
      Throws:
      IOException

    • hasBits

      public boolean hasBits()
       The bloom filter data.
      .google.firestore.v1.BitSequence bits = 1;
      Specified by:
      hasBits in interface BloomFilterOrBuilder
      Returns:
      Whether the bits field is set.

    • getBits

      public BitSequence getBits()
       The bloom filter data.
      .google.firestore.v1.BitSequence bits = 1;
      Specified by:
      getBits in interface BloomFilterOrBuilder
      Returns:
      The bits.

    • setBits

      public BloomFilter.Builder setBits(BitSequence value)
       The bloom filter data.
      .google.firestore.v1.BitSequence bits = 1;

    • setBits

      public BloomFilter.Builder setBits(BitSequence.Builder builderForValue)
       The bloom filter data.
      .google.firestore.v1.BitSequence bits = 1;

    • mergeBits

      public BloomFilter.Builder mergeBits(BitSequence value)
       The bloom filter data.
      .google.firestore.v1.BitSequence bits = 1;

    • clearBits

      public BloomFilter.Builder clearBits()
       The bloom filter data.
      .google.firestore.v1.BitSequence bits = 1;

    • getBitsBuilder

      public BitSequence.Builder getBitsBuilder()
       The bloom filter data.
      .google.firestore.v1.BitSequence bits = 1;

    • getBitsOrBuilder

      public BitSequenceOrBuilder getBitsOrBuilder()
       The bloom filter data.
      .google.firestore.v1.BitSequence bits = 1;
      Specified by:
      getBitsOrBuilder in interface BloomFilterOrBuilder

    • getHashCount

      public int getHashCount()
       The number of hashes used by the algorithm.
      int32 hash_count = 2;
      Specified by:
      getHashCount in interface BloomFilterOrBuilder
      Returns:
      The hashCount.

    • setHashCount

      public BloomFilter.Builder setHashCount(int value)
       The number of hashes used by the algorithm.
      int32 hash_count = 2;
      Parameters:
      value - The hashCount to set.
      Returns:
      This builder for chaining.

    • clearHashCount

      public BloomFilter.Builder clearHashCount()
       The number of hashes used by the algorithm.
      int32 hash_count = 2;
      Returns:
      This builder for chaining.