Class PartitionQueryResponse (3.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class PartitionQueryResponse : IMessage<PartitionQueryResponse>, IEquatable<PartitionQueryResponse>, IDeepCloneable<PartitionQueryResponse>, IBufferMessage, IMessage, IPageResponse<Cursor>, IEnumerable<Cursor>, IEnumerable

The response for [Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].

Inheritance

Object > PartitionQueryResponse

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

PartitionQueryResponse()

public PartitionQueryResponse()

PartitionQueryResponse(PartitionQueryResponse)

public PartitionQueryResponse(PartitionQueryResponse other)
Parameter
NameDescription
otherPartitionQueryResponse

Properties

NextPageToken

public string NextPageToken { get; set; }

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.

Property Value
TypeDescription
String

Partitions

public RepeatedField<Cursor> Partitions { get; }

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.

Property Value
TypeDescription
RepeatedField<Cursor>

Methods

GetEnumerator()

public IEnumerator<Cursor> GetEnumerator()

Returns an enumerator that iterates through the resources in this response.

Returns
TypeDescription
IEnumerator<Cursor>

Explicit Interface Implementations

IEnumerable.GetEnumerator()

IEnumerator IEnumerable.GetEnumerator()
Returns
TypeDescription
IEnumerator