Package com.google.firestore.v1

Interface PartitionQueryResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PartitionQueryResponse, PartitionQueryResponse.Builder
public interface PartitionQueryResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getPartitionsList

      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;

    • getPartitions

      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;

    • getPartitionsCount

      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;

    • getPartitionsOrBuilderList

      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;

    • getPartitionsOrBuilder

      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;

    • getNextPageToken

      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;
      Returns:
      The nextPageToken.

    • getNextPageTokenBytes

      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;
      Returns:
      The bytes for nextPageToken.