GoogleApi.Firestore.V1.Model.Write (google_api_firestore v0.21.3) View Source

A write on a document.


  • currentDocument (type: GoogleApi.Firestore.V1.Model.Precondition.t, default: nil) - An optional precondition on the document. The write will fail if this is set and not met by the target document.
  • delete (type: String.t, default: nil) - A document name to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.
  • transform (type: GoogleApi.Firestore.V1.Model.DocumentTransform.t, default: nil) - Applies a transformation to a document.
  • update (type: GoogleApi.Firestore.V1.Model.Document.t, default: nil) - A document to write.
  • updateMask (type: GoogleApi.Firestore.V1.Model.DocumentMask.t, default: nil) - 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.
  • updateTransforms (type: list(GoogleApi.Firestore.V1.Model.FieldTransform.t), default: nil) - The transforms to perform after update. This field can be set only when the operation is update. If present, this write is equivalent to performing update and transform to the same document atomically and in order.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.Firestore.V1.Model.Write{
  currentDocument: GoogleApi.Firestore.V1.Model.Precondition.t() | nil,
  delete: String.t() | nil,
  transform: GoogleApi.Firestore.V1.Model.DocumentTransform.t() | nil,
  update: GoogleApi.Firestore.V1.Model.Document.t() | nil,
  updateMask: GoogleApi.Firestore.V1.Model.DocumentMask.t() | nil,
  updateTransforms: [GoogleApi.Firestore.V1.Model.FieldTransform.t()] | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.