Method: googleapis.firestore.v1.projects.databases.documents.createDocument

Creates a new document.

Arguments

Parameters
`collectionId`	`string` Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`.
`parent`	`string` Required. The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`
`documentId`	`string` The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.
`mask.fieldPaths`	`string` The list of field paths in the mask. See Document.fields for a field path syntax reference.
`body`	`object (Document)` Required.

Raised exceptions

Exceptions
`ConnectionError`	In case of a network problem (such as DNS failure or refused connection).
`HttpError`	If the response status is >= 400 (excluding 429 and 503).
`TimeoutError`	If a long-running operation takes longer to finish than the specified timeout limit.
`TypeError`	If an operation or function receives an argument of the wrong type.
`ValueError`	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of Document.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- createDocument:
    call: googleapis.firestore.v1.projects.databases.documents.createDocument
    args:
        collectionId: ...
        parent: ...
        documentId: ...
        mask:
            fieldPaths: ...
        body:
            fields: ...
            name: ...
    result: createDocumentResult

JSON

[
  {
    "createDocument": {
      "call": "googleapis.firestore.v1.projects.databases.documents.createDocument",
      "args": {
        "collectionId": "...",
        "parent": "...",
        "documentId": "...",
        "mask": {
          "fieldPaths": "..."
        },
        "body": {
          "fields": "...",
          "name": "..."
        }
      },
      "result": "createDocumentResult"
    }
  }
]