get method

Future<Document> get (
  1. String name,
  2. {List<String> mask_fieldPaths,
  3. String transaction,
  4. String readTime,
  5. String $fields}

Gets a single document.

Request parameters:

name - Required. The resource name of the Document to get. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}. Value must have pattern "^projects/^/+/databases/^/+/documents/^/+/.*$".

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

transaction - Reads the document in a transaction.

readTime - Reads the version of the document at the given time. This may not be older than 270 seconds.

$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> get(core.String name,
    {core.List<core.String> mask_fieldPaths,
    core.String transaction,
    core.String readTime,
    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 (name == null) {
    throw new core.ArgumentError("Parameter name is required.");
  if (mask_fieldPaths != null) {
    _queryParams["mask.fieldPaths"] = mask_fieldPaths;
  if (transaction != null) {
    _queryParams["transaction"] = [transaction];
  if (readTime != null) {
    _queryParams["readTime"] = [readTime];
  if ($fields != null) {
    _queryParams["fields"] = [$fields];

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

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