Class UpdateDocumentRequest (2.5.0)

UpdateDocumentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request for Firestore.UpdateDocument][google.firestore.v1.Firestore.UpdateDocument].

Attributes

NameDescription
document google.cloud.firestore_v1.types.Document
Required. The updated document. Creates the document if it does not already exist.
update_mask google.cloud.firestore_v1.types.DocumentMask
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.
mask google.cloud.firestore_v1.types.DocumentMask
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.
current_document google.cloud.firestore_v1.types.Precondition
An optional precondition on the document. The request will fail if this is set and not met by the target document.

Inheritance

builtins.object > proto.message.Message > UpdateDocumentRequest