Class PartitionQueryRequest

The request for Firestore.PartitionQuery.

Inheritance
object
PartitionQueryRequest
Implements
Inherited Members
Namespace: Google.Apis.Firestore.v1.Data
Assembly: Google.Apis.Firestore.v1.dll
Syntax
public class PartitionQueryRequest : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

PageSize

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.

Declaration
[JsonProperty("pageSize")]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

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

Declaration
[JsonProperty("pageToken")]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

PartitionCount

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.

Declaration
[JsonProperty("partitionCount")]
public virtual long? PartitionCount { get; set; }
Property Value
Type Description
long?

ReadTime

object representation of ReadTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ReadTimeDateTimeOffset instead.")]
public virtual object ReadTime { get; set; }
Property Value
Type Description
object

ReadTimeDateTimeOffset

DateTimeOffset representation of ReadTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? ReadTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ReadTimeRaw

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.

Declaration
[JsonProperty("readTime")]
public virtual string ReadTimeRaw { get; set; }
Property Value
Type Description
string

StructuredQuery

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.

Declaration
[JsonProperty("structuredQuery")]
public virtual StructuredQuery StructuredQuery { get; set; }
Property Value
Type Description
StructuredQuery

Implements