Firestore v1 API - Class PartitionQueryRequest (3.8.0) 

public sealed class PartitionQueryRequest : IMessage<PartitionQueryRequest>, IEquatable<PartitionQueryRequest>, IDeepCloneable<PartitionQueryRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Firestore v1 API class PartitionQueryRequest.

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

Inheritance

object > PartitionQueryRequest

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

PartitionQueryRequest()

public PartitionQueryRequest()

PartitionQueryRequest(PartitionQueryRequest)

public PartitionQueryRequest(PartitionQueryRequest other)
Parameter
Name Description
other PartitionQueryRequest

Properties

ConsistencySelectorCase

public PartitionQueryRequest.ConsistencySelectorOneofCase ConsistencySelectorCase { get; }
Property Value
Type Description
PartitionQueryRequestConsistencySelectorOneofCase

PageSize

public int PageSize { get; set; }

The maximum number of partitions to return in this call, subject to partition_count.

For example, if partition_count = 10 and page_size = 8, the first call to PartitionQuery will return up to 8 partitions and a next_page_token if more results exist. A second call to PartitionQuery will return up to 2 partitions, to complete the total of 10 specified in partition_count.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

The next_page_token value returned from a previous call to PartitionQuery that may be used to get an additional set of results. There are no ordering guarantees between sets of results. Thus, using multiple sets of results will require merging the different result sets.

For example, two subsequent calls using a page_token may return:

  • cursor B, cursor M, cursor Q
  • cursor A, cursor U, cursor W

To obtain a complete result set ordered with respect to the results of the query supplied to PartitionQuery, the results sets should be merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents. Document resource names are not supported; only database resource names can be specified.

Property Value
Type Description
string

PartitionCount

public long PartitionCount { get; set; }

The desired maximum number of partition points. The partitions may be returned across multiple pages of results. The number must be positive. The actual number of partitions returned may be fewer.

For example, this may be set to one fewer than the number of parallel queries to be run, or in running a data pipeline job, one fewer than the number of workers or compute instances available.

Property Value
Type Description
long

QueryTypeCase

public PartitionQueryRequest.QueryTypeOneofCase QueryTypeCase { get; }
Property Value
Type Description
PartitionQueryRequestQueryTypeOneofCase

ReadTime

public Timestamp ReadTime { get; set; }

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

Property Value
Type Description
Timestamp

StructuredQuery

public StructuredQuery StructuredQuery { get; set; }

A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported.

Property Value
Type Description
StructuredQuery