Package com.google.firestore.v1

Class DocumentChange

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.DocumentChange
All Implemented Interfaces:
DocumentChangeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class DocumentChange extends com.google.protobuf.GeneratedMessageV3 implements DocumentChangeOrBuilder
 A [Document][google.firestore.v1.Document] has changed.

 May be the result of multiple [writes][google.firestore.v1.Write], including
 deletes, that ultimately resulted in a new value for the
 [Document][google.firestore.v1.Document].

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    DocumentChange.Builder
    A [Document][google.firestore.v1.Document] has changed.

    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
    REMOVED_TARGET_IDS_FIELD_NUMBER
     
    static final int
    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 DocumentChange
    getDefaultInstance()
     
    DocumentChange
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Document
    getDocument()
    The new state of the [Document][google.firestore.v1.Document].
    DocumentOrBuilder
    getDocumentOrBuilder()
    The new state of the [Document][google.firestore.v1.Document].
    com.google.protobuf.Parser<DocumentChange>
    getParserForType()
     
    int
    getRemovedTargetIds(int index)
    A set of target IDs for targets that no longer match this document.
    int
    getRemovedTargetIdsCount()
    A set of target IDs for targets that no longer match this document.
    List<Integer>
    getRemovedTargetIdsList()
    A set of target IDs for targets that no longer match this document.
    int
    getSerializedSize()
     
    int
    getTargetIds(int index)
    A set of target IDs of targets that match this document.
    int
    getTargetIdsCount()
    A set of target IDs of targets that match this document.
    List<Integer>
    getTargetIdsList()
    A set of target IDs of targets that match this document.
    boolean
    hasDocument()
    The new state of the [Document][google.firestore.v1.Document].
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static DocumentChange.Builder
    newBuilder()
     
    static DocumentChange.Builder
    newBuilder(DocumentChange prototype)
     
    DocumentChange.Builder
    newBuilderForType()
     
    protected DocumentChange.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static DocumentChange
    parseDelimitedFrom(InputStream input)
     
    static DocumentChange
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DocumentChange
    parseFrom(byte[] data)
     
    static DocumentChange
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DocumentChange
    parseFrom(com.google.protobuf.ByteString data)
     
    static DocumentChange
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DocumentChange
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static DocumentChange
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DocumentChange
    parseFrom(InputStream input)
     
    static DocumentChange
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DocumentChange
    parseFrom(ByteBuffer data)
     
    static DocumentChange
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<DocumentChange>
    parser()
     
    DocumentChange.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:

    • TARGET_IDS_FIELD_NUMBER

      public static final int TARGET_IDS_FIELD_NUMBER
      See Also:

    • REMOVED_TARGET_IDS_FIELD_NUMBER

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

    • hasDocument

      public boolean hasDocument()
       The new state of the [Document][google.firestore.v1.Document].

 If `mask` is set, contains only fields that were updated or added.
      .google.firestore.v1.Document document = 1;
      Specified by:
      hasDocument in interface DocumentChangeOrBuilder
      Returns:
      Whether the document field is set.

    • getDocument

      public Document getDocument()
       The new state of the [Document][google.firestore.v1.Document].

 If `mask` is set, contains only fields that were updated or added.
      .google.firestore.v1.Document document = 1;
      Specified by:
      getDocument in interface DocumentChangeOrBuilder
      Returns:
      The document.

    • getDocumentOrBuilder

      public DocumentOrBuilder getDocumentOrBuilder()
       The new state of the [Document][google.firestore.v1.Document].

 If `mask` is set, contains only fields that were updated or added.
      .google.firestore.v1.Document document = 1;
      Specified by:
      getDocumentOrBuilder in interface DocumentChangeOrBuilder

    • getTargetIdsList

      public List<Integer> getTargetIdsList()
       A set of target IDs of targets that match this document.
      repeated int32 target_ids = 5;
      Specified by:
      getTargetIdsList in interface DocumentChangeOrBuilder
      Returns:
      A list containing the targetIds.

    • getTargetIdsCount

      public int getTargetIdsCount()
       A set of target IDs of targets that match this document.
      repeated int32 target_ids = 5;
      Specified by:
      getTargetIdsCount in interface DocumentChangeOrBuilder
      Returns:
      The count of targetIds.

    • getTargetIds

      public int getTargetIds(int index)
       A set of target IDs of targets that match this document.
      repeated int32 target_ids = 5;
      Specified by:
      getTargetIds in interface DocumentChangeOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The targetIds at the given index.

    • getRemovedTargetIdsList

      public List<Integer> getRemovedTargetIdsList()
       A set of target IDs for targets that no longer match this document.
      repeated int32 removed_target_ids = 6;
      Specified by:
      getRemovedTargetIdsList in interface DocumentChangeOrBuilder
      Returns:
      A list containing the removedTargetIds.

    • getRemovedTargetIdsCount

      public int getRemovedTargetIdsCount()
       A set of target IDs for targets that no longer match this document.
      repeated int32 removed_target_ids = 6;
      Specified by:
      getRemovedTargetIdsCount in interface DocumentChangeOrBuilder
      Returns:
      The count of removedTargetIds.

    • getRemovedTargetIds

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DocumentChange.Builder newBuilder()

    • newBuilder

      public static DocumentChange.Builder newBuilder(DocumentChange prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DocumentChange getDefaultInstance()

    • parser

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

    • getParserForType

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