google_api_firestore v0.11.0 GoogleApi.Firestore.V1.Model.Write View Source
A write on a document.
Attributes
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. At most onetransform
per document is allowed in a given request. Anupdate
cannot follow atransform
on the same document in a given request.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 anupdate
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.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
t()
View Sourcet() :: %GoogleApi.Firestore.V1.Model.Write{ currentDocument: GoogleApi.Firestore.V1.Model.Precondition.t(), delete: String.t(), transform: GoogleApi.Firestore.V1.Model.DocumentTransform.t(), update: GoogleApi.Firestore.V1.Model.Document.t(), updateMask: GoogleApi.Firestore.V1.Model.DocumentMask.t() }
Link to this section Functions
Unwrap a decoded JSON object into its complex fields.