public sealed class RunQueryRequest : IMessage<RunQueryRequest>, IEquatable<RunQueryRequest>, IDeepCloneable<RunQueryRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Firestore v1 API class RunQueryRequest.
The request for [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].
public TransactionOptions NewTransaction { get; set; }
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.
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
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe latest version of the \u003ccode\u003eRunQueryRequest\u003c/code\u003e class is 3.10.0, with previous versions ranging from 3.9.0 down to 2.3.0 available for reference.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eRunQueryRequest\u003c/code\u003e is a class within the Google.Cloud.Firestore.V1 namespace, representing the request for Firestore.RunQuery operations.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eRunQueryRequest\u003c/code\u003e class implements several interfaces including IMessage, IEquatable, IDeepCloneable, and IBufferMessage, and has constructors for default and copy operations.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eRunQueryRequest\u003c/code\u003e class allows for specifying query options such as \u003ccode\u003eExplainOptions\u003c/code\u003e, \u003ccode\u003eNewTransaction\u003c/code\u003e, \u003ccode\u003eReadTime\u003c/code\u003e, and \u003ccode\u003eStructuredQuery\u003c/code\u003e and is the parent to the \u003ccode\u003eConsistencySelectorCase\u003c/code\u003e and \u003ccode\u003eQueryTypeCase\u003c/code\u003e properties, allowing for complex query configurations.\u003c/p\u003e\n"],["\u003cp\u003eThis class has key properties like \u003ccode\u003eParent\u003c/code\u003e, \u003ccode\u003eTransaction\u003c/code\u003e and \u003ccode\u003eReadTime\u003c/code\u003e, which allow specifying the document path, transaction details, and the specific time to read the document respectively.\u003c/p\u003e\n"]]],[],null,["# Firestore v1 API - Class RunQueryRequest (3.10.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.10.0 (latest)](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.RunQueryRequest)\n- [3.9.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.9.0/Google.Cloud.Firestore.V1.RunQueryRequest)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.8.0/Google.Cloud.Firestore.V1.RunQueryRequest)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.7.0/Google.Cloud.Firestore.V1.RunQueryRequest)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.6.0/Google.Cloud.Firestore.V1.RunQueryRequest)\n- [3.5.1](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.5.1/Google.Cloud.Firestore.V1.RunQueryRequest)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.4.0/Google.Cloud.Firestore.V1.RunQueryRequest)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.3.0/Google.Cloud.Firestore.V1.RunQueryRequest)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.2.0/Google.Cloud.Firestore.V1.RunQueryRequest)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.1.0/Google.Cloud.Firestore.V1.RunQueryRequest)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.0.0/Google.Cloud.Firestore.V1.RunQueryRequest)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/2.5.0/Google.Cloud.Firestore.V1.RunQueryRequest)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/2.4.0/Google.Cloud.Firestore.V1.RunQueryRequest)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/2.3.0/Google.Cloud.Firestore.V1.RunQueryRequest) \n\n public sealed class RunQueryRequest : IMessage\u003cRunQueryRequest\u003e, IEquatable\u003cRunQueryRequest\u003e, IDeepCloneable\u003cRunQueryRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Firestore v1 API class RunQueryRequest.\n\nThe request for \\[Firestore.RunQuery\\]\\[google.firestore.v1.Firestore.RunQuery\\]. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e RunQueryRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[RunQueryRequest](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.RunQueryRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[RunQueryRequest](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.RunQueryRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[RunQueryRequest](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.RunQueryRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Firestore.V1](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.Firestore.V1.dll\n\nConstructors\n------------\n\n### RunQueryRequest()\n\n public RunQueryRequest()\n\n### RunQueryRequest(RunQueryRequest)\n\n public RunQueryRequest(RunQueryRequest other)\n\nProperties\n----------\n\n### ConsistencySelectorCase\n\n public RunQueryRequest.ConsistencySelectorOneofCase ConsistencySelectorCase { get; }\n\n### ExplainOptions\n\n public ExplainOptions ExplainOptions { get; set; }\n\nOptional. Explain options for the query. If set, additional query\nstatistics will be returned. If not, only query results will be returned.\n\n### HasTransaction\n\n public bool HasTransaction { get; }\n\nGets whether the \"transaction\" field is set\n\n### NewTransaction\n\n public TransactionOptions NewTransaction { get; set; }\n\nStarts a new transaction and reads the documents.\nDefaults to a read-only transaction.\nThe new transaction ID will be returned as the first response in the\nstream.\n\n### Parent\n\n public string Parent { get; set; }\n\nRequired. The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`\n\n### QueryTypeCase\n\n public RunQueryRequest.QueryTypeOneofCase QueryTypeCase { get; }\n\n### ReadTime\n\n public Timestamp ReadTime { get; set; }\n\nReads documents as they were at the given time.\n\nThis must be a microsecond precision timestamp within the past one hour,\nor if Point-in-Time Recovery is enabled, can additionally be a whole\nminute timestamp within the past 7 days.\n\n### StructuredQuery\n\n public StructuredQuery StructuredQuery { get; set; }\n\nA structured query.\n\n### Transaction\n\n public ByteString Transaction { get; set; }\n\nRun the query within an already active transaction.\n\nThe value here is the opaque transaction ID to execute the query in."]]
