delete method
Deletes a single VMware Cluster.
Request parameters:
name
- Required. Name of the VMware user cluster to be deleted. Format:
"projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}"
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/vmwareClusters/\[^/\]+$
.
allowMissing
- If set to true, and the VMware cluster is not found, the
request will succeed but no action will be taken on the server and return
a completed LRO.
etag
- The current etag of the VMware cluster. If an etag is provided
and does not match the current etag of the cluster, deletion will be
blocked and an ABORTED error will be returned.
force
- If set to true, any node pools from the cluster will also be
deleted.
ignoreErrors
- If set to true, the deletion of a VMware user cluster
resource will succeed even if errors occur during deletion. This parameter
can be used when you want to delete GCP's cluster resource and the on-prem
admin cluster that hosts your user cluster is disconnected / unreachable
or deleted. WARNING: Using this parameter when your user cluster still
exists may result in a deleted GCP user cluster but an existing on-prem
user cluster.
validateOnly
- Validate the request without actually doing any updates.
$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? allowMissing,
core.String? etag,
core.bool? force,
core.bool? ignoreErrors,
core.bool? validateOnly,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (allowMissing != null) 'allowMissing': ['${allowMissing}'],
if (etag != null) 'etag': [etag],
if (force != null) 'force': ['${force}'],
if (ignoreErrors != null) 'ignoreErrors': ['${ignoreErrors}'],
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>);
}