public sealed class BatchGetDocumentsRequest : IMessage<BatchGetDocumentsRequest>, IEquatable<BatchGetDocumentsRequest>, IDeepCloneable<BatchGetDocumentsRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Firestore v1 API class BatchGetDocumentsRequest.
The request for
[Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].
The names of the documents to retrieve. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
The request will fail if any of the document is not a child resource of the
given database. Duplicate names will be elided.
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.
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\u003eThis webpage provides documentation for the \u003ccode\u003eBatchGetDocumentsRequest\u003c/code\u003e class within the Google Cloud Firestore v1 API, specifically for .NET developers, detailing its usage in retrieving multiple documents.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eBatchGetDocumentsRequest\u003c/code\u003e class is a part of the \u003ccode\u003eGoogle.Cloud.Firestore.V1\u003c/code\u003e namespace and is used as the request object for the \u003ccode\u003eFirestore.BatchGetDocuments\u003c/code\u003e API call, supporting features like transactions and read times.\u003c/p\u003e\n"],["\u003cp\u003eThe class has multiple versions available, from 2.3.0 to the latest 3.10.0, and it implements several interfaces including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe class provides properties for specifying the database, the list of documents to retrieve, the fields to include in the response, and options for transactions or read times, making it highly customizable.\u003c/p\u003e\n"],["\u003cp\u003eIt includes constructors to create new instances, one being an empty constructor, and the other taking in an already existing \u003ccode\u003eBatchGetDocumentsRequest\u003c/code\u003e for its parameters.\u003c/p\u003e\n"]]],[],null,["# Firestore v1 API - Class BatchGetDocumentsRequest (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.BatchGetDocumentsRequest)\n- [3.9.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.9.0/Google.Cloud.Firestore.V1.BatchGetDocumentsRequest)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.8.0/Google.Cloud.Firestore.V1.BatchGetDocumentsRequest)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.7.0/Google.Cloud.Firestore.V1.BatchGetDocumentsRequest)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.6.0/Google.Cloud.Firestore.V1.BatchGetDocumentsRequest)\n- [3.5.1](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.5.1/Google.Cloud.Firestore.V1.BatchGetDocumentsRequest)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.4.0/Google.Cloud.Firestore.V1.BatchGetDocumentsRequest)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.3.0/Google.Cloud.Firestore.V1.BatchGetDocumentsRequest)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.2.0/Google.Cloud.Firestore.V1.BatchGetDocumentsRequest)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.1.0/Google.Cloud.Firestore.V1.BatchGetDocumentsRequest)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.0.0/Google.Cloud.Firestore.V1.BatchGetDocumentsRequest)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/2.5.0/Google.Cloud.Firestore.V1.BatchGetDocumentsRequest)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/2.4.0/Google.Cloud.Firestore.V1.BatchGetDocumentsRequest)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/2.3.0/Google.Cloud.Firestore.V1.BatchGetDocumentsRequest) \n\n public sealed class BatchGetDocumentsRequest : IMessage\u003cBatchGetDocumentsRequest\u003e, IEquatable\u003cBatchGetDocumentsRequest\u003e, IDeepCloneable\u003cBatchGetDocumentsRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Firestore v1 API class BatchGetDocumentsRequest.\n\nThe request for\n\\[Firestore.BatchGetDocuments\\]\\[google.firestore.v1.Firestore.BatchGetDocuments\\]. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e BatchGetDocumentsRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[BatchGetDocumentsRequest](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.BatchGetDocumentsRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[BatchGetDocumentsRequest](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.BatchGetDocumentsRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[BatchGetDocumentsRequest](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.BatchGetDocumentsRequest), [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### BatchGetDocumentsRequest()\n\n public BatchGetDocumentsRequest()\n\n### BatchGetDocumentsRequest(BatchGetDocumentsRequest)\n\n public BatchGetDocumentsRequest(BatchGetDocumentsRequest other)\n\nProperties\n----------\n\n### ConsistencySelectorCase\n\n public BatchGetDocumentsRequest.ConsistencySelectorOneofCase ConsistencySelectorCase { get; }\n\n### Database\n\n public string Database { get; set; }\n\nRequired. The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.\n\n### Documents\n\n public RepeatedField\u003cstring\u003e Documents { get; }\n\nThe names of the documents to retrieve. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nThe request will fail if any of the document is not a child resource of the\ngiven `database`. Duplicate names will be elided.\n\n### HasTransaction\n\n public bool HasTransaction { get; }\n\nGets whether the \"transaction\" field is set\n\n### Mask\n\n public DocumentMask Mask { get; set; }\n\nThe fields to return. If not set, returns all fields.\n\nIf a document has a field that is not present in this mask, that field will\nnot be returned in the response.\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### 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### Transaction\n\n public ByteString Transaction { get; set; }\n\nReads documents in a transaction."]]
