CreateDocumentRequest

google.firestore.v1. CreateDocumentRequest

Represents a CreateDocumentRequest.

Constructor

new CreateDocumentRequest(propertiesopt)

Constructs a new CreateDocumentRequest.

Parameters:
Name Type Attributes Description
properties google.firestore.v1.ICreateDocumentRequest <optional>

Properties to set

Implements:
  • ICreateDocumentRequest

Members

collectionId

CreateDocumentRequest collectionId.

document

CreateDocumentRequest document.

documentId

CreateDocumentRequest documentId.

mask

CreateDocumentRequest mask.

parent

CreateDocumentRequest parent.

Methods

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

Converts this CreateDocumentRequest to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) fromObject(object) → {google.firestore.v1.CreateDocumentRequest}

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

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

Plain object

Returns:
Type Description
google.firestore.v1.CreateDocumentRequest

CreateDocumentRequest

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for CreateDocumentRequest

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

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

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

Parameters:
Name Type Attributes Description
message google.firestore.v1.CreateDocumentRequest

CreateDocumentRequest

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object