Interface PartitionQueryResponseOrBuilder (3.30.2) 

public interface PartitionQueryResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getNextPageToken()

public abstract 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
Type Description
String

The nextPageToken.

getNextPageTokenBytes()

public abstract 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
Type Description
ByteString

The bytes for nextPageToken.

getPartitions(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
Cursor

getPartitionsCount()

public abstract 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;

Returns
Type Description
int

getPartitionsList()

public abstract 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;

Returns
Type Description
List<Cursor>

getPartitionsOrBuilder(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
CursorOrBuilder

getPartitionsOrBuilderList()

public abstract 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;

Returns
Type Description
List<? extends com.google.firestore.v1.CursorOrBuilder>