impersonateQuery method

Future<GraphqlResponse> impersonateQuery(
  1. ImpersonateRequest request,
  2. String name, {
  3. String? $fields,
})

Impersonate a query defined on a Firebase Data Connect connector.

It grants the admin SDK access to queries defined in the given connector. The caller can choose to impersonate a particular Firebase Auth user, or skip @auth completely.

request - The metadata request object.

Request parameters:

name - Required. The resource name of the connector to find the predefined query/mutation, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector}

Value must have pattern
`^projects/\[^/\]+/locations/\[^/\]+/services/\[^/\]+/connectors/\[^/\]+$`.

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

Completes with a [GraphqlResponse].

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<GraphqlResponse> impersonateQuery(
  ImpersonateRequest request,
  core.String name, {
  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('$name') + ':impersonateQuery';

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