class Google::Apis::FirestoreV1::PartitionQueryRequest
The request for Firestore.PartitionQuery.
Attributes
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
`. Corresponds to the JSON property `pageSize` @return [Fixnum]
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 Corresponds to the JSON property `pageToken` @return [String]
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. Corresponds to the JSON property `partitionCount` @return [Fixnum]
A Firestore query. Corresponds to the JSON property `structuredQuery` @return [Google::Apis::FirestoreV1::StructuredQuery]
Public Class Methods
# File lib/google/apis/firestore_v1/classes.rb, line 1833 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/firestore_v1/classes.rb, line 1838 def update!(**args) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) @partition_count = args[:partition_count] if args.key?(:partition_count) @structured_query = args[:structured_query] if args.key?(:structured_query) end