GoogleApi.Firestore.V1beta1.Model.PartitionQueryResponse (google_api_firestore v0.21.3) View Source

The response for Firestore.PartitionQuery.


  • nextPageToken (type: String.t, default: nil) - 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.
  • partitions (type: list(GoogleApi.Firestore.V1beta1.Model.Cursor.t), default: nil) - 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.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.Firestore.V1beta1.Model.PartitionQueryResponse{
  nextPageToken: String.t() | nil,
  partitions: [GoogleApi.Firestore.V1beta1.Model.Cursor.t()] | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.