delete method

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

Deletes the specified workstation cluster.

Request parameters:

name - Required. Name of the workstation cluster to delete. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/workstationClusters/\[^/\]+$.

etag - Optional. If set, the request will be rejected if the latest version of the workstation cluster on the server does not have this ETag.

force - Optional. If set, any workstation configurations and workstations in the workstation cluster are also deleted. Otherwise, the request only works if the workstation cluster has no configurations or workstations.

validateOnly - Optional. If set, validate the request and preview the review, but do not apply it.

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