delete method

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

Deletes an existing Backup.

Request parameters:

name - Required. Name of the Backup resource. Format: projects / * /locations / * /backupPlans / * /backups / * Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/backupPlans/\[^/\]+/backups/\[^/\]+$.

etag - Optional. If provided, this value must match the current value of the target Backup's etag field or the request is rejected.

force - Optional. If set to true, any VolumeBackups below this Backup will also be deleted. Otherwise, the request will only succeed if the Backup has no VolumeBackups.

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

Completes with a GoogleLongrunningOperation.

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