delete method

Future<Operation> delete(
  1. String name, {
  2. bool? force,
  3. String? $fields,
})

Deletes an instance.

Request parameters:

name - Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$.

force - If set to true, all snapshots of the instance will also be deleted. (Otherwise, the request will only work if the instance has no snapshots.)

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

Completes with a Operation.

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

  final url_ = 'v1/' + core.Uri.encodeFull('$name');

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