google_api_firestore v0.0.1 GoogleApi.Firestore.V1beta1.Model.Write View Source

A write on a document.

Attributes

  • currentDocument (Precondition): An optional precondition on the document. The write will fail if this is set and not met by the target document. Defaults to: null.
  • delete (String.t): A document name to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. Defaults to: null.
  • transform (DocumentTransform): Applies a tranformation to a document. At most one `transform` per document is allowed in a given request. An `update` cannot follow a `transform` on the same document in a given request. Defaults to: null.
  • update (Document): A document to write. Defaults to: null.
  • updateMask (DocumentMask): The fields to update in this write. This field can be set only when the operation is `update`. If the mask is not set for an `update` and 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. Defaults to: null.