The fields to update. None of the field paths in the mask may contain a reserved name. If the document exists on the server and has fields not referenced in the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server.
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.
None of the field paths in the mask may contain a reserved name.
If the document exists on the server and has fields not referenced in the
mask, they are left unchanged.
Fields referenced in the mask, but not present in the input document, are
deleted from the document on the server.
None of the field paths in the mask may contain a reserved name.
If the document exists on the server and has fields not referenced in the
mask, they are left unchanged.
Fields referenced in the mask, but not present in the input document, are
deleted from the document on the server.
[[["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 V1beta1 Client - Class UpdateDocumentRequest (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/V1beta1.UpdateDocumentRequest)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/V1beta1.UpdateDocumentRequest)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/V1beta1.UpdateDocumentRequest)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/V1beta1.UpdateDocumentRequest)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/V1beta1.UpdateDocumentRequest)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/V1beta1.UpdateDocumentRequest)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/V1beta1.UpdateDocumentRequest)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/V1beta1.UpdateDocumentRequest)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/V1beta1.UpdateDocumentRequest)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/V1beta1.UpdateDocumentRequest)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/V1beta1.UpdateDocumentRequest)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/V1beta1.UpdateDocumentRequest)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/V1beta1.UpdateDocumentRequest)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/V1beta1.UpdateDocumentRequest)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/V1beta1.UpdateDocumentRequest)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/V1beta1.UpdateDocumentRequest)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/V1beta1.UpdateDocumentRequest)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/V1beta1.UpdateDocumentRequest)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/V1beta1.UpdateDocumentRequest)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/V1beta1.UpdateDocumentRequest)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/V1beta1.UpdateDocumentRequest)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/V1beta1.UpdateDocumentRequest)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/V1beta1.UpdateDocumentRequest) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Cloud Firestore V1beta1 Client class UpdateDocumentRequest.\n\nThe request for Firestore.UpdateDocument.\n\nGenerated from protobuf message `google.firestore.v1beta1.UpdateDocumentRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ V1beta1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDocument\n\nRequired. The updated document.\n\nCreates the document if it does not already exist.\n\n### setDocument\n\nRequired. The updated document.\n\nCreates the document if it does not already exist.\n\n### getUpdateMask\n\nThe fields to update.\n\nNone of the field paths in the mask may contain a reserved name.\nIf the document exists on the server and has fields not referenced in the\nmask, they are left unchanged.\nFields referenced in the mask, but not present in the input document, are\ndeleted from the document on the server.\n\n### setUpdateMask\n\nThe fields to update.\n\nNone of the field paths in the mask may contain a reserved name.\nIf the document exists on the server and has fields not referenced in the\nmask, they are left unchanged.\nFields referenced in the mask, but not present in the input document, are\ndeleted from the document on the server.\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### 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### getCurrentDocument\n\nAn optional precondition on the document.\n\nThe request will fail if this is set and not met by the target document.\n\n### setCurrentDocument\n\nAn optional precondition on the document.\n\nThe request will fail if this is set and not met by the target document."]]
