Package com.google.firestore.v1

Class TargetChange

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.TargetChange
All Implemented Interfaces:
TargetChangeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class TargetChange extends com.google.protobuf.GeneratedMessageV3 implements TargetChangeOrBuilder
 Targets being watched have changed.
Protobuf type google.firestore.v1.TargetChange
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    TargetChange.Builder
    Targets being watched have changed.
    static enum 
    TargetChange.TargetChangeType
    The type of change.

    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
    CAUSE_FIELD_NUMBER
     
    static final int
    READ_TIME_FIELD_NUMBER
     
    static final int
    RESUME_TOKEN_FIELD_NUMBER
     
    static final int
    TARGET_CHANGE_TYPE_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)
     
    com.google.rpc.Status
    getCause()
    The error that resulted in this change, if applicable.
    com.google.rpc.StatusOrBuilder
    getCauseOrBuilder()
    The error that resulted in this change, if applicable.
    static TargetChange
    getDefaultInstance()
     
    TargetChange
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<TargetChange>
    getParserForType()
     
    com.google.protobuf.Timestamp
    getReadTime()
    The consistent `read_time` for the given `target_ids` (omitted when the target_ids are not at a consistent snapshot).
    com.google.protobuf.TimestampOrBuilder
    getReadTimeOrBuilder()
    The consistent `read_time` for the given `target_ids` (omitted when the target_ids are not at a consistent snapshot).
    com.google.protobuf.ByteString
    getResumeToken()
    A token that can be used to resume the stream for the given `target_ids`, or all targets if `target_ids` is empty.
    int
    getSerializedSize()
     
    TargetChange.TargetChangeType
    getTargetChangeType()
    The type of change that occurred.
    int
    getTargetChangeTypeValue()
    The type of change that occurred.
    int
    getTargetIds(int index)
    The target IDs of targets that have changed.
    int
    getTargetIdsCount()
    The target IDs of targets that have changed.
    List<Integer>
    getTargetIdsList()
    The target IDs of targets that have changed.
    boolean
    hasCause()
    The error that resulted in this change, if applicable.
    int
    hashCode()
     
    boolean
    hasReadTime()
    The consistent `read_time` for the given `target_ids` (omitted when the target_ids are not at a consistent snapshot).
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static TargetChange.Builder
    newBuilder()
     
    static TargetChange.Builder
    newBuilder(TargetChange prototype)
     
    TargetChange.Builder
    newBuilderForType()
     
    protected TargetChange.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static TargetChange
    parseDelimitedFrom(InputStream input)
     
    static TargetChange
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TargetChange
    parseFrom(byte[] data)
     
    static TargetChange
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TargetChange
    parseFrom(com.google.protobuf.ByteString data)
     
    static TargetChange
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TargetChange
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static TargetChange
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TargetChange
    parseFrom(InputStream input)
     
    static TargetChange
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TargetChange
    parseFrom(ByteBuffer data)
     
    static TargetChange
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<TargetChange>
    parser()
     
    TargetChange.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_CHANGE_TYPE_FIELD_NUMBER

      public static final int TARGET_CHANGE_TYPE_FIELD_NUMBER
      See Also:

    • TARGET_IDS_FIELD_NUMBER

      public static final int TARGET_IDS_FIELD_NUMBER
      See Also:

    • CAUSE_FIELD_NUMBER

      public static final int CAUSE_FIELD_NUMBER
      See Also:

    • RESUME_TOKEN_FIELD_NUMBER

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

    • getTargetChangeTypeValue

      public int getTargetChangeTypeValue()
       The type of change that occurred.
      .google.firestore.v1.TargetChange.TargetChangeType target_change_type = 1;
      Specified by:
      getTargetChangeTypeValue in interface TargetChangeOrBuilder
      Returns:
      The enum numeric value on the wire for targetChangeType.

    • getTargetChangeType

      public TargetChange.TargetChangeType getTargetChangeType()
       The type of change that occurred.
      .google.firestore.v1.TargetChange.TargetChangeType target_change_type = 1;
      Specified by:
      getTargetChangeType in interface TargetChangeOrBuilder
      Returns:
      The targetChangeType.

    • getTargetIdsList

      public List<Integer> getTargetIdsList()
       The target IDs of targets that have changed.

 If empty, the change applies to all targets.

 The order of the target IDs is not defined.
      repeated int32 target_ids = 2;
      Specified by:
      getTargetIdsList in interface TargetChangeOrBuilder
      Returns:
      A list containing the targetIds.

    • getTargetIdsCount

      public int getTargetIdsCount()
       The target IDs of targets that have changed.

 If empty, the change applies to all targets.

 The order of the target IDs is not defined.
      repeated int32 target_ids = 2;
      Specified by:
      getTargetIdsCount in interface TargetChangeOrBuilder
      Returns:
      The count of targetIds.

    • getTargetIds

      public int getTargetIds(int index)
       The target IDs of targets that have changed.

 If empty, the change applies to all targets.

 The order of the target IDs is not defined.
      repeated int32 target_ids = 2;
      Specified by:
      getTargetIds in interface TargetChangeOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The targetIds at the given index.

    • hasCause

      public boolean hasCause()
       The error that resulted in this change, if applicable.
      .google.rpc.Status cause = 3;
      Specified by:
      hasCause in interface TargetChangeOrBuilder
      Returns:
      Whether the cause field is set.

    • getCause

      public com.google.rpc.Status getCause()
       The error that resulted in this change, if applicable.
      .google.rpc.Status cause = 3;
      Specified by:
      getCause in interface TargetChangeOrBuilder
      Returns:
      The cause.

    • getCauseOrBuilder

      public com.google.rpc.StatusOrBuilder getCauseOrBuilder()
       The error that resulted in this change, if applicable.
      .google.rpc.Status cause = 3;
      Specified by:
      getCauseOrBuilder in interface TargetChangeOrBuilder

    • getResumeToken

      public com.google.protobuf.ByteString getResumeToken()
       A token that can be used to resume the stream for the given `target_ids`,
 or all targets if `target_ids` is empty.

 Not set on every target change.
      bytes resume_token = 4;
      Specified by:
      getResumeToken in interface TargetChangeOrBuilder
      Returns:
      The resumeToken.

    • hasReadTime

      public boolean hasReadTime()
       The consistent `read_time` for the given `target_ids` (omitted when the
 target_ids are not at a consistent snapshot).

 The stream is guaranteed to send a `read_time` with `target_ids` empty
 whenever the entire stream reaches a new consistent snapshot. ADD,
 CURRENT, and RESET messages are guaranteed to (eventually) result in a
 new consistent snapshot (while NO_CHANGE and REMOVE messages are not).

 For a given stream, `read_time` is guaranteed to be monotonically
 increasing.
      .google.protobuf.Timestamp read_time = 6;
      Specified by:
      hasReadTime in interface TargetChangeOrBuilder
      Returns:
      Whether the readTime field is set.

    • getReadTime

      public com.google.protobuf.Timestamp getReadTime()
       The consistent `read_time` for the given `target_ids` (omitted when the
 target_ids are not at a consistent snapshot).

 The stream is guaranteed to send a `read_time` with `target_ids` empty
 whenever the entire stream reaches a new consistent snapshot. ADD,
 CURRENT, and RESET messages are guaranteed to (eventually) result in a
 new consistent snapshot (while NO_CHANGE and REMOVE messages are not).

 For a given stream, `read_time` is guaranteed to be monotonically
 increasing.
      .google.protobuf.Timestamp read_time = 6;
      Specified by:
      getReadTime in interface TargetChangeOrBuilder
      Returns:
      The readTime.

    • getReadTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
       The consistent `read_time` for the given `target_ids` (omitted when the
 target_ids are not at a consistent snapshot).

 The stream is guaranteed to send a `read_time` with `target_ids` empty
 whenever the entire stream reaches a new consistent snapshot. ADD,
 CURRENT, and RESET messages are guaranteed to (eventually) result in a
 new consistent snapshot (while NO_CHANGE and REMOVE messages are not).

 For a given stream, `read_time` is guaranteed to be monotonically
 increasing.
      .google.protobuf.Timestamp read_time = 6;
      Specified by:
      getReadTimeOrBuilder in interface TargetChangeOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static TargetChange.Builder newBuilder()

    • newBuilder

      public static TargetChange.Builder newBuilder(TargetChange prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static TargetChange getDefaultInstance()

    • parser

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

    • getParserForType

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