Package com.google.firestore.v1

Class DocumentRemove

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.DocumentRemove
All Implemented Interfaces:
DocumentRemoveOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class DocumentRemove extends com.google.protobuf.GeneratedMessageV3 implements DocumentRemoveOrBuilder
 A [Document][google.firestore.v1.Document] has been removed from the view of
 the targets.

 Sent if the document is no longer relevant to a target and is out of view.
 Can be sent instead of a DocumentDelete or a DocumentChange if the server
 can not send the new value of the document.

 Multiple [DocumentRemove][google.firestore.v1.DocumentRemove] messages may be
 returned for the same logical write or delete, if multiple targets are
 affected.
Protobuf type google.firestore.v1.DocumentRemove
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    DocumentRemove.Builder
    A [Document][google.firestore.v1.Document] has been removed from the view of the targets.

    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
    DOCUMENT_FIELD_NUMBER
     
    static final int
    READ_TIME_FIELD_NUMBER
     
    static final int
    REMOVED_TARGET_IDS_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)
     
    static DocumentRemove
    getDefaultInstance()
     
    DocumentRemove
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getDocument()
    The resource name of the [Document][google.firestore.v1.Document] that has gone out of view.
    com.google.protobuf.ByteString
    getDocumentBytes()
    The resource name of the [Document][google.firestore.v1.Document] that has gone out of view.
    com.google.protobuf.Parser<DocumentRemove>
    getParserForType()
     
    com.google.protobuf.Timestamp
    getReadTime()
    The read timestamp at which the remove was observed.
    com.google.protobuf.TimestampOrBuilder
    getReadTimeOrBuilder()
    The read timestamp at which the remove was observed.
    int
    getRemovedTargetIds(int index)
    A set of target IDs for targets that previously matched this document.
    int
    getRemovedTargetIdsCount()
    A set of target IDs for targets that previously matched this document.
    List<Integer>
    getRemovedTargetIdsList()
    A set of target IDs for targets that previously matched this document.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasReadTime()
    The read timestamp at which the remove was observed.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static DocumentRemove.Builder
    newBuilder()
     
    static DocumentRemove.Builder
    newBuilder(DocumentRemove prototype)
     
    DocumentRemove.Builder
    newBuilderForType()
     
    protected DocumentRemove.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static DocumentRemove
    parseDelimitedFrom(InputStream input)
     
    static DocumentRemove
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DocumentRemove
    parseFrom(byte[] data)
     
    static DocumentRemove
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DocumentRemove
    parseFrom(com.google.protobuf.ByteString data)
     
    static DocumentRemove
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DocumentRemove
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static DocumentRemove
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DocumentRemove
    parseFrom(InputStream input)
     
    static DocumentRemove
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DocumentRemove
    parseFrom(ByteBuffer data)
     
    static DocumentRemove
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<DocumentRemove>
    parser()
     
    DocumentRemove.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

    • DOCUMENT_FIELD_NUMBER

      public static final int DOCUMENT_FIELD_NUMBER
      See Also:

    • REMOVED_TARGET_IDS_FIELD_NUMBER

      public static final int REMOVED_TARGET_IDS_FIELD_NUMBER
      See Also:

    • READ_TIME_FIELD_NUMBER

      public static final int READ_TIME_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

    • getDocument

      public String getDocument()
       The resource name of the [Document][google.firestore.v1.Document] that has
 gone out of view.
      string document = 1;
      Specified by:
      getDocument in interface DocumentRemoveOrBuilder
      Returns:
      The document.

    • getDocumentBytes

      public com.google.protobuf.ByteString getDocumentBytes()
       The resource name of the [Document][google.firestore.v1.Document] that has
 gone out of view.
      string document = 1;
      Specified by:
      getDocumentBytes in interface DocumentRemoveOrBuilder
      Returns:
      The bytes for document.

    • getRemovedTargetIdsList

      public List<Integer> getRemovedTargetIdsList()
       A set of target IDs for targets that previously matched this document.
      repeated int32 removed_target_ids = 2;
      Specified by:
      getRemovedTargetIdsList in interface DocumentRemoveOrBuilder
      Returns:
      A list containing the removedTargetIds.

    • getRemovedTargetIdsCount

      public int getRemovedTargetIdsCount()
       A set of target IDs for targets that previously matched this document.
      repeated int32 removed_target_ids = 2;
      Specified by:
      getRemovedTargetIdsCount in interface DocumentRemoveOrBuilder
      Returns:
      The count of removedTargetIds.

    • getRemovedTargetIds

      public int getRemovedTargetIds(int index)
       A set of target IDs for targets that previously matched this document.
      repeated int32 removed_target_ids = 2;
      Specified by:
      getRemovedTargetIds in interface DocumentRemoveOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The removedTargetIds at the given index.

    • hasReadTime

      public boolean hasReadTime()
       The read timestamp at which the remove was observed.

 Greater or equal to the `commit_time` of the change/delete/remove.
      .google.protobuf.Timestamp read_time = 4;
      Specified by:
      hasReadTime in interface DocumentRemoveOrBuilder
      Returns:
      Whether the readTime field is set.

    • getReadTime

      public com.google.protobuf.Timestamp getReadTime()
       The read timestamp at which the remove was observed.

 Greater or equal to the `commit_time` of the change/delete/remove.
      .google.protobuf.Timestamp read_time = 4;
      Specified by:
      getReadTime in interface DocumentRemoveOrBuilder
      Returns:
      The readTime.

    • getReadTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
       The read timestamp at which the remove was observed.

 Greater or equal to the `commit_time` of the change/delete/remove.
      .google.protobuf.Timestamp read_time = 4;
      Specified by:
      getReadTimeOrBuilder in interface DocumentRemoveOrBuilder

    • 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 DocumentRemove parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DocumentRemove.Builder newBuilder()

    • newBuilder

      public static DocumentRemove.Builder newBuilder(DocumentRemove prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DocumentRemove getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<DocumentRemove> 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 DocumentRemove getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder