public sealed class GetDocumentRequest : IMessage<GetDocumentRequest>, IEquatable<GetDocumentRequest>, IDeepCloneable<GetDocumentRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Firestore v1 API class GetDocumentRequest.
The request for
[Firestore.GetDocument][google.firestore.v1.Firestore.GetDocument].
Reads the version of the document 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.
[[["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 document provides reference information for the \u003ccode\u003eGetDocumentRequest\u003c/code\u003e class within the Google Cloud Firestore v1 API, specifically for .NET development, covering versions from 2.3.0 up to the latest 3.10.0.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGetDocumentRequest\u003c/code\u003e is used to request a document from Firestore, with methods for specifying the document's name, which fields to include or exclude, and whether to read a specific version or within a transaction.\u003c/p\u003e\n"],["\u003cp\u003eThe class 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, making it compatible with various .NET functionalities.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of the \u003ccode\u003eGetDocumentRequest\u003c/code\u003e class include \u003ccode\u003eName\u003c/code\u003e for the document's resource name, \u003ccode\u003eMask\u003c/code\u003e for specifying returned fields, and \u003ccode\u003eReadTime\u003c/code\u003e or \u003ccode\u003eTransaction\u003c/code\u003e for consistency-related choices.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of this API is version 3.10.0.\u003c/p\u003e\n"]]],[],null,["# Firestore v1 API - Class GetDocumentRequest (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.GetDocumentRequest)\n- [3.9.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.9.0/Google.Cloud.Firestore.V1.GetDocumentRequest)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.8.0/Google.Cloud.Firestore.V1.GetDocumentRequest)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.7.0/Google.Cloud.Firestore.V1.GetDocumentRequest)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.6.0/Google.Cloud.Firestore.V1.GetDocumentRequest)\n- [3.5.1](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.5.1/Google.Cloud.Firestore.V1.GetDocumentRequest)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.4.0/Google.Cloud.Firestore.V1.GetDocumentRequest)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.3.0/Google.Cloud.Firestore.V1.GetDocumentRequest)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.2.0/Google.Cloud.Firestore.V1.GetDocumentRequest)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.1.0/Google.Cloud.Firestore.V1.GetDocumentRequest)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.0.0/Google.Cloud.Firestore.V1.GetDocumentRequest)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/2.5.0/Google.Cloud.Firestore.V1.GetDocumentRequest)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/2.4.0/Google.Cloud.Firestore.V1.GetDocumentRequest)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/2.3.0/Google.Cloud.Firestore.V1.GetDocumentRequest) \n\n public sealed class GetDocumentRequest : IMessage\u003cGetDocumentRequest\u003e, IEquatable\u003cGetDocumentRequest\u003e, IDeepCloneable\u003cGetDocumentRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Firestore v1 API class GetDocumentRequest.\n\nThe request for\n\\[Firestore.GetDocument\\]\\[google.firestore.v1.Firestore.GetDocument\\]. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e GetDocumentRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[GetDocumentRequest](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.GetDocumentRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[GetDocumentRequest](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.GetDocumentRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[GetDocumentRequest](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.GetDocumentRequest), [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### GetDocumentRequest()\n\n public GetDocumentRequest()\n\n### GetDocumentRequest(GetDocumentRequest)\n\n public GetDocumentRequest(GetDocumentRequest other)\n\nProperties\n----------\n\n### ConsistencySelectorCase\n\n public GetDocumentRequest.ConsistencySelectorOneofCase ConsistencySelectorCase { get; }\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 the document has a field that is not present in this mask, that field\nwill not be returned in the response.\n\n### Name\n\n public string Name { get; set; }\n\nRequired. The resource name of the Document to get. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\n\n### ReadTime\n\n public Timestamp ReadTime { get; set; }\n\nReads the version of the document 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 the document in a transaction."]]
