Cloud Firestore V1 Client - Class PartitionQueryResponse (1.40.0)

Version 1.40.0

• 1.47.1 (latest)
• 1.47.0
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

Reference documentation and code samples for the Cloud Firestore V1 Client class PartitionQueryResponse.

The response for Firestore.PartitionQuery.

Generated from protobuf message google.firestore.v1.PartitionQueryResponse

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ partitions	array<Google\Cloud\Firestore\V1\Cursor> 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.
↳ next_page_token	string 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.

getPartitions

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.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setPartitions

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.

Parameter
Name	Description
var	array<Google\Cloud\Firestore\V1\Cursor>

Returns
Type	Description
$this

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.

Returns
Type	Description
string

setNextPageToken

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this