disable method

Future<DatabaseInstance> disable(
  1. DisableDatabaseInstanceRequest request,
  2. String name, {
  3. String? $fields,
})

Disables a DatabaseInstance.

The database can be re-enabled later using ReenableDatabaseInstance. When a database is disabled, all reads and writes are denied, including view access in the Firebase console.

request - The metadata request object.

Request parameters:

name - The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$.

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

Completes with a DatabaseInstance.

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<DatabaseInstance> disable(
  DisableDatabaseInstanceRequest request,
  core.String name, {
  core.String? $fields,
}) async {
  final _body = convert.json.encode(request.toJson());
  final _queryParams = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final _url = 'v1beta/' + core.Uri.encodeFull('$name') + ':disable';

  final _response = await _requester.request(
    _url,
    'POST',
    body: _body,
    queryParams: _queryParams,
  );
  return DatabaseInstance.fromJson(
      _response as core.Map<core.String, core.dynamic>);
}