runQuery method

Future<RunQueryResponse> runQuery(
  1. RunQueryRequest request,
  2. String parent, {
  3. String? $fields,
})

Runs a query.

request - The metadata request object.

Request parameters:

parent - Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom Value must have pattern ^projects/\[^/\]+/databases/\[^/\]+/documents/\[^/\]+/.*$.

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

Completes with a RunQueryResponse.

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<RunQueryResponse> runQuery(
  RunQueryRequest request,
  core.String parent, {
  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('$parent') + ':runQuery';

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