get method

Future<Document> get(String name, { List<String>? mask_fieldPaths, String? readTime, String? transaction, 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.

readTime - Reads the version of the document at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

transaction - Reads the document in a transaction.

$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> get(
  core.String name, {
  core.List<core.String>? mask_fieldPaths,
  core.String? readTime,
  core.String? transaction,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'mask.fieldPaths': ?mask_fieldPaths,
    'readTime': ?readTime == null ? null : [readTime],
    'transaction': ?transaction == null ? null : [transaction],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name');

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return Document.fromJson(response_ as core.Map<core.String, core.dynamic>);
}