Applies a transformation to a document. At most onetransformper document is allowed in a given request. Anupdatecannot follow atransformon the same document in a given request.
The fields to update in this write. This field can be set only when the operation isupdate. If the mask is not set for anupdateand the document exists, any existing data will be overwritten. If the mask is set and the document on the server has fields not covered by 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 field paths in this mask must not contain a reserved field name.
This field can be set only when the operation isupdate.
If the mask is not set for anupdateand the document exists, any
existing data will be overwritten.
If the mask is set and the document on the server has fields not covered by
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 field paths in this mask must not contain a reserved field name.
This field can be set only when the operation isupdate.
If the mask is not set for anupdateand the document exists, any
existing data will be overwritten.
If the mask is set and the document on the server has fields not covered by
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 field paths in this mask must not contain a reserved field name.
[[["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 Write (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/V1beta1.Write)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/V1beta1.Write)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/V1beta1.Write)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/V1beta1.Write)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/V1beta1.Write)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/V1beta1.Write)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/V1beta1.Write)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/V1beta1.Write)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/V1beta1.Write)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/V1beta1.Write)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/V1beta1.Write)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/V1beta1.Write)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/V1beta1.Write)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/V1beta1.Write)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/V1beta1.Write)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/V1beta1.Write)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/V1beta1.Write)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/V1beta1.Write)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/V1beta1.Write)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/V1beta1.Write)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/V1beta1.Write)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/V1beta1.Write)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/V1beta1.Write) \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 Write.\n\nA write on a document.\n\nGenerated from protobuf message `google.firestore.v1beta1.Write`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ V1beta1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getUpdate\n\nA document to write.\n\n### setUpdate\n\nA document to write.\n\n### getDelete\n\nA document name to delete. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\n\n### setDelete\n\nA document name to delete. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\n\n### getTransform\n\nApplies a transformation to a document.\n\nAt most one `transform` per document is allowed in a given request.\nAn `update` cannot follow a `transform` on the same document in a given\nrequest.\n\n### setTransform\n\nApplies a transformation to a document.\n\nAt most one `transform` per document is allowed in a given request.\nAn `update` cannot follow a `transform` on the same document in a given\nrequest.\n\n### getUpdateMask\n\nThe fields to update in this write.\n\nThis field can be set only when the operation is `update`.\nIf the mask is not set for an `update` and the document exists, any\nexisting data will be overwritten.\nIf the mask is set and the document on the server has fields not covered by\nthe mask, they are left unchanged.\nFields referenced in the mask, but not present in the input document, are\ndeleted from the document on the server.\nThe field paths in this mask must not contain a reserved field name.\n\n### setUpdateMask\n\nThe fields to update in this write.\n\nThis field can be set only when the operation is `update`.\nIf the mask is not set for an `update` and the document exists, any\nexisting data will be overwritten.\nIf the mask is set and the document on the server has fields not covered by\nthe mask, they are left unchanged.\nFields referenced in the mask, but not present in the input document, are\ndeleted from the document on the server.\nThe field paths in this mask must not contain a reserved field name.\n\n### getCurrentDocument\n\nAn optional precondition on the document.\n\nThe write 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 write will fail if this is set and not met by the target document.\n\n### getOperation"]]
