Package com.google.firestore.v1

Class Target

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.Target
All Implemented Interfaces:
TargetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class Target extends com.google.protobuf.GeneratedMessageV3 implements TargetOrBuilder
 A specification of a set of documents to listen to.
Protobuf type google.firestore.v1.Target
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Target.Builder
    A specification of a set of documents to listen to.
    static final class 
    Target.DocumentsTarget
    A target specified by a set of documents names.
    static interface 
    Target.DocumentsTargetOrBuilder
     
    static final class 
    Target.QueryTarget
    A target specified by a query.
    static interface 
    Target.QueryTargetOrBuilder
     
    static enum 
    Target.ResumeTypeCase
     
    static enum 
    Target.TargetTypeCase
     

    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
    DOCUMENTS_FIELD_NUMBER
     
    static final int
    EXPECTED_COUNT_FIELD_NUMBER
     
    static final int
    ONCE_FIELD_NUMBER
     
    static final int
    QUERY_FIELD_NUMBER
     
    static final int
    READ_TIME_FIELD_NUMBER
     
    static final int
    RESUME_TOKEN_FIELD_NUMBER
     
    static final int
    TARGET_ID_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 Target
    getDefaultInstance()
     
    Target
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Target.DocumentsTarget
    getDocuments()
    A target specified by a set of document names.
    Target.DocumentsTargetOrBuilder
    getDocumentsOrBuilder()
    A target specified by a set of document names.
    com.google.protobuf.Int32Value
    getExpectedCount()
    The number of documents that last matched the query at the resume token or read time.
    com.google.protobuf.Int32ValueOrBuilder
    getExpectedCountOrBuilder()
    The number of documents that last matched the query at the resume token or read time.
    boolean
    getOnce()
    If the target should be removed once it is current and consistent.
    com.google.protobuf.Parser<Target>
    getParserForType()
     
    Target.QueryTarget
    getQuery()
    A target specified by a query.
    Target.QueryTargetOrBuilder
    getQueryOrBuilder()
    A target specified by a query.
    com.google.protobuf.Timestamp
    getReadTime()
    Start listening after a specific `read_time`.
    com.google.protobuf.TimestampOrBuilder
    getReadTimeOrBuilder()
    Start listening after a specific `read_time`.
    com.google.protobuf.ByteString
    getResumeToken()
    A resume token from a prior [TargetChange][google.firestore.v1.TargetChange] for an identical target.
    Target.ResumeTypeCase
    getResumeTypeCase()
     
    int
    getSerializedSize()
     
    int
    getTargetId()
    The target ID that identifies the target on the stream.
    Target.TargetTypeCase
    getTargetTypeCase()
     
    boolean
    hasDocuments()
    A target specified by a set of document names.
    boolean
    hasExpectedCount()
    The number of documents that last matched the query at the resume token or read time.
    int
    hashCode()
     
    boolean
    hasQuery()
    A target specified by a query.
    boolean
    hasReadTime()
    Start listening after a specific `read_time`.
    boolean
    hasResumeToken()
    A resume token from a prior [TargetChange][google.firestore.v1.TargetChange] for an identical target.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Target.Builder
    newBuilder()
     
    static Target.Builder
    newBuilder(Target prototype)
     
    Target.Builder
    newBuilderForType()
     
    protected Target.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Target
    parseDelimitedFrom(InputStream input)
     
    static Target
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Target
    parseFrom(byte[] data)
     
    static Target
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Target
    parseFrom(com.google.protobuf.ByteString data)
     
    static Target
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Target
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Target
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Target
    parseFrom(InputStream input)
     
    static Target
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Target
    parseFrom(ByteBuffer data)
     
    static Target
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Target>
    parser()
     
    Target.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

  • 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

    • getTargetTypeCase

      public Target.TargetTypeCase getTargetTypeCase()
      Specified by:
      getTargetTypeCase in interface TargetOrBuilder

    • getResumeTypeCase

      public Target.ResumeTypeCase getResumeTypeCase()
      Specified by:
      getResumeTypeCase in interface TargetOrBuilder

    • hasQuery

      public boolean hasQuery()
       A target specified by a query.
      .google.firestore.v1.Target.QueryTarget query = 2;
      Specified by:
      hasQuery in interface TargetOrBuilder
      Returns:
      Whether the query field is set.

    • getQuery

      public Target.QueryTarget getQuery()
       A target specified by a query.
      .google.firestore.v1.Target.QueryTarget query = 2;
      Specified by:
      getQuery in interface TargetOrBuilder
      Returns:
      The query.

    • getQueryOrBuilder

      public Target.QueryTargetOrBuilder getQueryOrBuilder()
       A target specified by a query.
      .google.firestore.v1.Target.QueryTarget query = 2;
      Specified by:
      getQueryOrBuilder in interface TargetOrBuilder

    • hasDocuments

      public boolean hasDocuments()
       A target specified by a set of document names.
      .google.firestore.v1.Target.DocumentsTarget documents = 3;
      Specified by:
      hasDocuments in interface TargetOrBuilder
      Returns:
      Whether the documents field is set.

    • getDocuments

      public Target.DocumentsTarget getDocuments()
       A target specified by a set of document names.
      .google.firestore.v1.Target.DocumentsTarget documents = 3;
      Specified by:
      getDocuments in interface TargetOrBuilder
      Returns:
      The documents.

    • getDocumentsOrBuilder

      public Target.DocumentsTargetOrBuilder getDocumentsOrBuilder()
       A target specified by a set of document names.
      .google.firestore.v1.Target.DocumentsTarget documents = 3;
      Specified by:
      getDocumentsOrBuilder in interface TargetOrBuilder

    • hasResumeToken

      public boolean hasResumeToken()
       A resume token from a prior
 [TargetChange][google.firestore.v1.TargetChange] for an identical target.

 Using a resume token with a different target is unsupported and may fail.
      bytes resume_token = 4;
      Specified by:
      hasResumeToken in interface TargetOrBuilder
      Returns:
      Whether the resumeToken field is set.

    • getResumeToken

      public com.google.protobuf.ByteString getResumeToken()
       A resume token from a prior
 [TargetChange][google.firestore.v1.TargetChange] for an identical target.

 Using a resume token with a different target is unsupported and may fail.
      bytes resume_token = 4;
      Specified by:
      getResumeToken in interface TargetOrBuilder
      Returns:
      The resumeToken.

    • hasReadTime

      public boolean hasReadTime()
       Start listening after a specific `read_time`.

 The client must know the state of matching documents at this time.
      .google.protobuf.Timestamp read_time = 11;
      Specified by:
      hasReadTime in interface TargetOrBuilder
      Returns:
      Whether the readTime field is set.

    • getReadTime

      public com.google.protobuf.Timestamp getReadTime()
       Start listening after a specific `read_time`.

 The client must know the state of matching documents at this time.
      .google.protobuf.Timestamp read_time = 11;
      Specified by:
      getReadTime in interface TargetOrBuilder
      Returns:
      The readTime.

    • getReadTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
       Start listening after a specific `read_time`.

 The client must know the state of matching documents at this time.
      .google.protobuf.Timestamp read_time = 11;
      Specified by:
      getReadTimeOrBuilder in interface TargetOrBuilder

    • getTargetId

      public int getTargetId()
       The target ID that identifies the target on the stream. Must be a positive
 number and non-zero.

 If `target_id` is 0 (or unspecified), the server will assign an ID for this
 target and return that in a `TargetChange::ADD` event. Once a target with
 `target_id=0` is added, all subsequent targets must also have
 `target_id=0`. If an `AddTarget` request with `target_id != 0` is
 sent to the server after a target with `target_id=0` is added, the server
 will immediately send a response with a `TargetChange::Remove` event.

 Note that if the client sends multiple `AddTarget` requests
 without an ID, the order of IDs returned in `TargetChage.target_ids` are
 undefined. Therefore, clients should provide a target ID instead of relying
 on the server to assign one.

 If `target_id` is non-zero, there must not be an existing active target on
 this stream with the same ID.
      int32 target_id = 5;
      Specified by:
      getTargetId in interface TargetOrBuilder
      Returns:
      The targetId.

    • getOnce

      public boolean getOnce()
       If the target should be removed once it is current and consistent.
      bool once = 6;
      Specified by:
      getOnce in interface TargetOrBuilder
      Returns:
      The once.

    • hasExpectedCount

      public boolean hasExpectedCount()
       The number of documents that last matched the query at the resume token or
 read time.

 This value is only relevant when a `resume_type` is provided. This value
 being present and greater than zero signals that the client wants
 `ExistenceFilter.unchanged_names` to be included in the response.
      .google.protobuf.Int32Value expected_count = 12;
      Specified by:
      hasExpectedCount in interface TargetOrBuilder
      Returns:
      Whether the expectedCount field is set.

    • getExpectedCount

      public com.google.protobuf.Int32Value getExpectedCount()
       The number of documents that last matched the query at the resume token or
 read time.

 This value is only relevant when a `resume_type` is provided. This value
 being present and greater than zero signals that the client wants
 `ExistenceFilter.unchanged_names` to be included in the response.
      .google.protobuf.Int32Value expected_count = 12;
      Specified by:
      getExpectedCount in interface TargetOrBuilder
      Returns:
      The expectedCount.

    • getExpectedCountOrBuilder

      public com.google.protobuf.Int32ValueOrBuilder getExpectedCountOrBuilder()
       The number of documents that last matched the query at the resume token or
 read time.

 This value is only relevant when a `resume_type` is provided. This value
 being present and greater than zero signals that the client wants
 `ExistenceFilter.unchanged_names` to be included in the response.
      .google.protobuf.Int32Value expected_count = 12;
      Specified by:
      getExpectedCountOrBuilder in interface TargetOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Target.Builder newBuilder()

    • newBuilder

      public static Target.Builder newBuilder(Target prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Target getDefaultInstance()

    • parser

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

    • getParserForType

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