createDocument method

Future<Document> createDocument (
  1. Document request,
  2. String parent,
  3. String collectionId,
  4. {String documentId,
  5. List<String> mask_fieldPaths,
  6. String $fields}

Creates a new document.

request - The metadata request object.

Request parameters:

parent - Required. The parent resource. For example: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id} Value must have pattern "^projects/^/+/databases/^/+/documents/.*$".

collectionId - Required. The collection ID, relative to parent, to list. For example: chatrooms.

documentId - The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.

mask_fieldPaths - The list of field paths in the mask. See Document.fields for a field path syntax reference.

$fields - Selector specifying which fields to include in a partial response.

Completes with a Document.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.


async.Future<Document> createDocument(
    Document request, core.String parent, core.String collectionId,
    {core.String documentId,
    core.List<core.String> mask_fieldPaths,
    core.String $fields}) {
  var _url;
  var _queryParams = new core.Map<core.String, core.List<core.String>>();
  var _uploadMedia;
  var _uploadOptions;
  var _downloadOptions = commons.DownloadOptions.Metadata;
  var _body;

  if (request != null) {
    _body = convert.json.encode((request).toJson());
  if (parent == null) {
    throw new core.ArgumentError("Parameter parent is required.");
  if (collectionId == null) {
    throw new core.ArgumentError("Parameter collectionId is required.");
  if (documentId != null) {
    _queryParams["documentId"] = [documentId];
  if (mask_fieldPaths != null) {
    _queryParams["mask.fieldPaths"] = mask_fieldPaths;
  if ($fields != null) {
    _queryParams["fields"] = [$fields];

  _url = 'v1/' +
      commons.Escaper.ecapeVariableReserved('$parent') +
      '/' +

  var _response = _requester.request(_url, "POST",
      body: _body,
      queryParams: _queryParams,
      uploadOptions: _uploadOptions,
      uploadMedia: _uploadMedia,
      downloadOptions: _downloadOptions);
  return _response.then((data) => new Document.fromJson(data));