Package com.google.firestore.v1

Class PartitionQueryResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.PartitionQueryResponse
All Implemented Interfaces:
PartitionQueryResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class PartitionQueryResponse extends com.google.protobuf.GeneratedMessageV3 implements PartitionQueryResponseOrBuilder
 The response for
 [Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].
Protobuf type google.firestore.v1.PartitionQueryResponse
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    PartitionQueryResponse.Builder
    The response for [Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].

    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
    NEXT_PAGE_TOKEN_FIELD_NUMBER
     
    static final int
    PARTITIONS_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 PartitionQueryResponse
    getDefaultInstance()
     
    PartitionQueryResponse
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getNextPageToken()
    A page token that may be used to request an additional set of results, up to the number specified by `partition_count` in the PartitionQuery request.
    com.google.protobuf.ByteString
    getNextPageTokenBytes()
    A page token that may be used to request an additional set of results, up to the number specified by `partition_count` in the PartitionQuery request.
    com.google.protobuf.Parser<PartitionQueryResponse>
    getParserForType()
     
    Cursor
    getPartitions(int index)
    Partition results.
    int
    getPartitionsCount()
    Partition results.
    List<Cursor>
    getPartitionsList()
    Partition results.
    CursorOrBuilder
    getPartitionsOrBuilder(int index)
    Partition results.
    List<? extends CursorOrBuilder>
    getPartitionsOrBuilderList()
    Partition results.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static PartitionQueryResponse.Builder
    newBuilder()
     
    static PartitionQueryResponse.Builder
    newBuilder(PartitionQueryResponse prototype)
     
    PartitionQueryResponse.Builder
    newBuilderForType()
     
    protected PartitionQueryResponse.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static PartitionQueryResponse
    parseDelimitedFrom(InputStream input)
     
    static PartitionQueryResponse
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PartitionQueryResponse
    parseFrom(byte[] data)
     
    static PartitionQueryResponse
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PartitionQueryResponse
    parseFrom(com.google.protobuf.ByteString data)
     
    static PartitionQueryResponse
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PartitionQueryResponse
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PartitionQueryResponse
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PartitionQueryResponse
    parseFrom(InputStream input)
     
    static PartitionQueryResponse
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PartitionQueryResponse
    parseFrom(ByteBuffer data)
     
    static PartitionQueryResponse
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PartitionQueryResponse>
    parser()
     
    PartitionQueryResponse.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

    • PARTITIONS_FIELD_NUMBER

      public static final int PARTITIONS_FIELD_NUMBER
      See Also:

    • NEXT_PAGE_TOKEN_FIELD_NUMBER

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

    • getPartitionsList

      public List<Cursor> getPartitionsList()
       Partition results.
 Each partition is a split point that can be used by RunQuery as a starting
 or end point for the query results. The RunQuery requests must be made with
 the same query supplied to this PartitionQuery request. The partition
 cursors will be ordered according to same ordering as the results of the
 query supplied to PartitionQuery.

 For example, if a PartitionQuery request returns partition cursors A and B,
 running the following three queries will return the entire result set of
 the original query:

  * query, end_at A
  * query, start_at A, end_at B
  * query, start_at B

 An empty result may indicate that the query has too few results to be
 partitioned, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;
      Specified by:
      getPartitionsList in interface PartitionQueryResponseOrBuilder

    • getPartitionsOrBuilderList

      public List<? extends CursorOrBuilder> getPartitionsOrBuilderList()
       Partition results.
 Each partition is a split point that can be used by RunQuery as a starting
 or end point for the query results. The RunQuery requests must be made with
 the same query supplied to this PartitionQuery request. The partition
 cursors will be ordered according to same ordering as the results of the
 query supplied to PartitionQuery.

 For example, if a PartitionQuery request returns partition cursors A and B,
 running the following three queries will return the entire result set of
 the original query:

  * query, end_at A
  * query, start_at A, end_at B
  * query, start_at B

 An empty result may indicate that the query has too few results to be
 partitioned, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;
      Specified by:
      getPartitionsOrBuilderList in interface PartitionQueryResponseOrBuilder

    • getPartitionsCount

      public int getPartitionsCount()
       Partition results.
 Each partition is a split point that can be used by RunQuery as a starting
 or end point for the query results. The RunQuery requests must be made with
 the same query supplied to this PartitionQuery request. The partition
 cursors will be ordered according to same ordering as the results of the
 query supplied to PartitionQuery.

 For example, if a PartitionQuery request returns partition cursors A and B,
 running the following three queries will return the entire result set of
 the original query:

  * query, end_at A
  * query, start_at A, end_at B
  * query, start_at B

 An empty result may indicate that the query has too few results to be
 partitioned, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;
      Specified by:
      getPartitionsCount in interface PartitionQueryResponseOrBuilder

    • getPartitions

      public Cursor getPartitions(int index)
       Partition results.
 Each partition is a split point that can be used by RunQuery as a starting
 or end point for the query results. The RunQuery requests must be made with
 the same query supplied to this PartitionQuery request. The partition
 cursors will be ordered according to same ordering as the results of the
 query supplied to PartitionQuery.

 For example, if a PartitionQuery request returns partition cursors A and B,
 running the following three queries will return the entire result set of
 the original query:

  * query, end_at A
  * query, start_at A, end_at B
  * query, start_at B

 An empty result may indicate that the query has too few results to be
 partitioned, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;
      Specified by:
      getPartitions in interface PartitionQueryResponseOrBuilder

    • getPartitionsOrBuilder

      public CursorOrBuilder getPartitionsOrBuilder(int index)
       Partition results.
 Each partition is a split point that can be used by RunQuery as a starting
 or end point for the query results. The RunQuery requests must be made with
 the same query supplied to this PartitionQuery request. The partition
 cursors will be ordered according to same ordering as the results of the
 query supplied to PartitionQuery.

 For example, if a PartitionQuery request returns partition cursors A and B,
 running the following three queries will return the entire result set of
 the original query:

  * query, end_at A
  * query, start_at A, end_at B
  * query, start_at B

 An empty result may indicate that the query has too few results to be
 partitioned, or that the query is not yet supported for partitioning.
      repeated .google.firestore.v1.Cursor partitions = 1;
      Specified by:
      getPartitionsOrBuilder in interface PartitionQueryResponseOrBuilder

    • getNextPageToken

      public String getNextPageToken()
       A page token that may be used to request an additional set of results, up
 to the number specified by `partition_count` in the PartitionQuery request.
 If blank, there are no more results.
      string next_page_token = 2;
      Specified by:
      getNextPageToken in interface PartitionQueryResponseOrBuilder
      Returns:
      The nextPageToken.

    • getNextPageTokenBytes

      public com.google.protobuf.ByteString getNextPageTokenBytes()
       A page token that may be used to request an additional set of results, up
 to the number specified by `partition_count` in the PartitionQuery request.
 If blank, there are no more results.
      string next_page_token = 2;
      Specified by:
      getNextPageTokenBytes in interface PartitionQueryResponseOrBuilder
      Returns:
      The bytes for nextPageToken.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static PartitionQueryResponse.Builder newBuilder()

    • newBuilder

      public static PartitionQueryResponse.Builder newBuilder(PartitionQueryResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static PartitionQueryResponse getDefaultInstance()

    • parser

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

    • getParserForType

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