Class RunAggregationQueryRequest (2.27.0) 

RunAggregationQueryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name Description
parent str
Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
structured_aggregation_query google.cloud.firestore_v1.types.StructuredAggregationQuery
An aggregation query. This field is a member of oneof_ query_type.
transaction bytes
Run the aggregation within an already active transaction. The value here is the opaque transaction ID to execute the query in. This field is a member of oneof_ consistency_selector.
new_transaction google.cloud.firestore_v1.types.TransactionOptions
Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream. This field is a member of oneof_ consistency_selector.
read_time google.protobuf.timestamp_pb2.Timestamp
Executes the query at the given timestamp. 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. This field is a member of oneof_ consistency_selector.
explain_options google.cloud.firestore_v1.types.ExplainOptions
Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.