UpdateDocumentRequest

google.firestore.v1beta1. UpdateDocumentRequest

Represents an UpdateDocumentRequest.

Constructor

new UpdateDocumentRequest(propertiesopt)

Constructs a new UpdateDocumentRequest.

Parameters:
Name Type Attributes Description
properties google.firestore.v1beta1.IUpdateDocumentRequest <optional>

Properties to set

Implements:
  • IUpdateDocumentRequest

Members

currentDocument :google.firestore.v1beta1.IPrecondition|null|undefined

UpdateDocumentRequest currentDocument.

document :google.firestore.v1beta1.IDocument|null|undefined

UpdateDocumentRequest document.

mask :google.firestore.v1beta1.IDocumentMask|null|undefined

UpdateDocumentRequest mask.

updateMask :google.firestore.v1beta1.IDocumentMask|null|undefined

UpdateDocumentRequest updateMask.

Methods

(static) fromObject(object) → {google.firestore.v1beta1.UpdateDocumentRequest}

Creates an UpdateDocumentRequest message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from an UpdateDocumentRequest message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.firestore.v1beta1.UpdateDocumentRequest

UpdateDocumentRequest

options $protobuf.IConversionOptions <optional>

Conversion options

toJSON() → {Object.<string, *>}

Converts this UpdateDocumentRequest to JSON.