Package com.google.firestore.v1

Class ExistenceFilter

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ExistenceFilter.Builder
    A digest of all the documents that match a given target.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    COUNT_FIELD_NUMBER
     
    static final int
    TARGET_ID_FIELD_NUMBER
     
    static final int
    UNCHANGED_NAMES_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    int
    getCount()
    The total count of documents that match [target_id][google.firestore.v1.ExistenceFilter.target_id].
    static ExistenceFilter
    getDefaultInstance()
     
    ExistenceFilter
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<ExistenceFilter>
    getParserForType()
     
    int
    getSerializedSize()
     
    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}`.
    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}`.
    int
    hashCode()
     
    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()
     
    static ExistenceFilter.Builder
    newBuilder()
     
    static ExistenceFilter.Builder
    newBuilder(ExistenceFilter prototype)
     
    ExistenceFilter.Builder
    newBuilderForType()
     
    protected ExistenceFilter.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static ExistenceFilter
    parseDelimitedFrom(InputStream input)
     
    static ExistenceFilter
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExistenceFilter
    parseFrom(byte[] data)
     
    static ExistenceFilter
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExistenceFilter
    parseFrom(com.google.protobuf.ByteString data)
     
    static ExistenceFilter
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExistenceFilter
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ExistenceFilter
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExistenceFilter
    parseFrom(InputStream input)
     
    static ExistenceFilter
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExistenceFilter
    parseFrom(ByteBuffer data)
     
    static ExistenceFilter
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ExistenceFilter>
    parser()
     
    ExistenceFilter.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • TARGET_ID_FIELD_NUMBER

      public static final int TARGET_ID_FIELD_NUMBER
      See Also:

    • COUNT_FIELD_NUMBER

      public static final int COUNT_FIELD_NUMBER
      See Also:

    • UNCHANGED_NAMES_FIELD_NUMBER

      public static final int UNCHANGED_NAMES_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

    • 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.

    • 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.

    • 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.

    • 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

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ExistenceFilter parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExistenceFilter parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExistenceFilter parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExistenceFilter parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExistenceFilter parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExistenceFilter parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExistenceFilter parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExistenceFilter parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExistenceFilter parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExistenceFilter parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExistenceFilter parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExistenceFilter parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static ExistenceFilter.Builder newBuilder()

    • newBuilder

      public static ExistenceFilter.Builder newBuilder(ExistenceFilter prototype)

    • toBuilder

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

    • newBuilderForType

      protected ExistenceFilter.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ExistenceFilter getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ExistenceFilter> parser()

    • getParserForType

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

    • getDefaultInstanceForType

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