batchGet method

Future<BatchGetDocumentsResponse> batchGet(
  1. BatchGetDocumentsRequest request,
  2. String database, {
  3. String? $fields,
})

Gets multiple documents.

Documents returned by this method are not guaranteed to be returned in the same order that they were requested.

request - The metadata request object.

Request parameters:

database - Required. The database name. In the format: projects/{project_id}/databases/{database_id}. Value must have pattern ^projects/\[^/\]+/databases/\[^/\]+$.

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

Completes with a BatchGetDocumentsResponse.

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<BatchGetDocumentsResponse> batchGet(
  BatchGetDocumentsRequest request,
  core.String database, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'v1/' + core.Uri.encodeFull('$database') + '/documents:batchGet';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return (response_ as core.List)
      .map((value) => BatchGetDocumentsResponseElement.fromJson(
          value as core.Map<core.String, core.dynamic>))
      .toList();
}