createDocument method

Future<Document> createDocument(Document request, String parent, String collectionId, { String? documentId, List<String>? mask_fieldPaths, 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.

Implementation

async.Future<Document> createDocument(
  Document request,
  core.String parent,
  core.String collectionId, {
  core.String? documentId,
  core.List<core.String>? mask_fieldPaths,
  core.String? $fields,
}) async {
  final _body = convert.json.encode(request);
  final _queryParams = <core.String, core.List<core.String>>{
    if (documentId != null) 'documentId': [documentId],
    if (mask_fieldPaths != null) 'mask.fieldPaths': mask_fieldPaths,
    if ($fields != null) 'fields': [$fields],
  };

  final _url = 'v1beta1/' +
      core.Uri.encodeFull('$parent') +
      '/' +
      commons.escapeVariable('$collectionId');

  final _response = await _requester.request(
    _url,
    'POST',
    body: _body,
    queryParams: _queryParams,
  );
  return Document.fromJson(_response as core.Map<core.String, core.dynamic>);
}