public sealed class UpdateDocumentRequest : IMessage<UpdateDocumentRequest>, IEquatable<UpdateDocumentRequest>, IDeepCloneable<UpdateDocumentRequest>, IBufferMessage, IMessageThe request for [Firestore.UpdateDocument][google.firestore.v1.Firestore.UpdateDocument].
Implements
IMessage<UpdateDocumentRequest>, IEquatable<UpdateDocumentRequest>, IDeepCloneable<UpdateDocumentRequest>, IBufferMessage, IMessageNamespace
Google.Cloud.Firestore.V1Assembly
Google.Cloud.Firestore.V1.dll
Constructors
UpdateDocumentRequest()
public UpdateDocumentRequest()UpdateDocumentRequest(UpdateDocumentRequest)
public UpdateDocumentRequest(UpdateDocumentRequest other)| Parameter | |
|---|---|
| Name | Description |
other | UpdateDocumentRequest |
Properties
CurrentDocument
public Precondition CurrentDocument { get; set; }An optional precondition on the document. The request will fail if this is set and not met by the target document.
| Property Value | |
|---|---|
| Type | Description |
Precondition | |
Document
public Document Document { get; set; }Required. The updated document. Creates the document if it does not already exist.
| Property Value | |
|---|---|
| Type | Description |
Document | |
Mask
public DocumentMask Mask { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
DocumentMask | |
UpdateMask
public DocumentMask UpdateMask { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
DocumentMask | |