The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.
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.
getName
Required. The resource name of the Document to get. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
Returns
Type
Description
string
setName
Required. The resource name of the Document to get. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getMask
The fields to return. If not set, returns all fields.
If the document has a field that is not present in this mask, that field
will not be returned in the response.
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.
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"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class GetDocumentRequest (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/V1.GetDocumentRequest)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/V1.GetDocumentRequest)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/V1.GetDocumentRequest)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/V1.GetDocumentRequest)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/V1.GetDocumentRequest)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/V1.GetDocumentRequest)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/V1.GetDocumentRequest)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/V1.GetDocumentRequest)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/V1.GetDocumentRequest)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/V1.GetDocumentRequest)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/V1.GetDocumentRequest)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/V1.GetDocumentRequest)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/V1.GetDocumentRequest)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/V1.GetDocumentRequest)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/V1.GetDocumentRequest)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/V1.GetDocumentRequest)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/V1.GetDocumentRequest)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/V1.GetDocumentRequest)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/V1.GetDocumentRequest)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/V1.GetDocumentRequest)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/V1.GetDocumentRequest)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/V1.GetDocumentRequest)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/V1.GetDocumentRequest) \nReference documentation and code samples for the Cloud Firestore V1 Client class GetDocumentRequest.\n\nThe request for\nFirestore.GetDocument.\n\nGenerated from protobuf message `google.firestore.v1.GetDocumentRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\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### setName\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### getMask\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### hasMask\n\n### clearMask\n\n### setMask\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### getTransaction\n\nReads the document in a transaction.\n\n### hasTransaction\n\n### setTransaction\n\nReads the document in a transaction.\n\n### getReadTime\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### hasReadTime\n\n### setReadTime\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### getConsistencySelector"]]
