delete method

Future<DatabaseInstance> delete(
  1. String name, {
  2. String? $fields,
})

Marks a DatabaseInstance to be deleted.

The DatabaseInstance will be purged within 30 days. The default database cannot be deleted. IDs for deleted database instances may never be recovered or re-used. The Database may only be deleted if it is already in a DISABLED state.

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> delete(
  core.String name, {
  core.String? $fields,
}) async {
  final _queryParams = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

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

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