Class RunQueryRequest (2.16.0)

Version latest

• 2.16.0 (latest)
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.1
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.3
• 2.6.1
• 2.5.3
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.3
• 2.0.2
• 1.9.2
• 1.8.1
• 1.7.0
• 1.6.2
• 1.5.0
• 1.4.0
• 1.3.0

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

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

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_query	google.cloud.firestore_v1.types.StructuredQuery A structured query. This field is a member of oneof_ query_type.
transaction	bytes Run the query 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 and reads the documents. Defaults to a read-only transaction. 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 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. 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.