Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::PartitionQueryRequest.
The request for Firestore.PartitionQuery.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#page_size
def page_size() -> ::Integer
-
(::Integer) — The maximum number of partitions to return in this call, subject to
partition_count
.For example, if
partition_count
= 10 andpage_size
= 8, the first call to PartitionQuery will return up to 8 partitions and anext_page_token
if more results exist. A second call to PartitionQuery will return up to 2 partitions, to complete the total of 10 specified inpartition_count
.
#page_size=
def page_size=(value) -> ::Integer
-
value (::Integer) — The maximum number of partitions to return in this call, subject to
partition_count
.For example, if
partition_count
= 10 andpage_size
= 8, the first call to PartitionQuery will return up to 8 partitions and anext_page_token
if more results exist. A second call to PartitionQuery will return up to 2 partitions, to complete the total of 10 specified inpartition_count
.
-
(::Integer) — The maximum number of partitions to return in this call, subject to
partition_count
.For example, if
partition_count
= 10 andpage_size
= 8, the first call to PartitionQuery will return up to 8 partitions and anext_page_token
if more results exist. A second call to PartitionQuery will return up to 2 partitions, to complete the total of 10 specified inpartition_count
.
#page_token
def page_token() -> ::String
-
(::String) — 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
#page_token=
def page_token=(value) -> ::String
-
value (::String) — 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
-
(::String) — 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
#parent
def parent() -> ::String
-
(::String) — 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.
#parent=
def parent=(value) -> ::String
-
value (::String) — 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.
-
(::String) — 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.
#partition_count
def partition_count() -> ::Integer
-
(::Integer) — 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.
#partition_count=
def partition_count=(value) -> ::Integer
-
value (::Integer) — 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.
-
(::Integer) — 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.
#read_time
def read_time() -> ::Google::Protobuf::Timestamp
-
(::Google::Protobuf::Timestamp) — 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.
#read_time=
def read_time=(value) -> ::Google::Protobuf::Timestamp
-
value (::Google::Protobuf::Timestamp) — 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.
-
(::Google::Protobuf::Timestamp) — 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.
#structured_query
def structured_query() -> ::Google::Cloud::Firestore::V1::StructuredQuery
- (::Google::Cloud::Firestore::V1::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.
#structured_query=
def structured_query=(value) -> ::Google::Cloud::Firestore::V1::StructuredQuery
- value (::Google::Cloud::Firestore::V1::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.
- (::Google::Cloud::Firestore::V1::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.