delete method
Deletes a single bare metal node pool.
Request parameters:
name
- Required. The name of the node pool to delete. Format:
projects/{project}/locations/{location}/bareMetalClusters/{cluster}/bareMetalNodePools/{nodepool}
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/bareMetalClusters/\[^/\]+/bareMetalNodePools/\[^/\]+$
.
allowMissing
- If set to true, and the bare metal node pool 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 BareMetalNodePool. If an etag is provided
and does not match the current etag of the node pool, deletion will be
blocked and an ABORTED error will be returned.
ignoreErrors
- If set to true, the deletion of a bare metal node pool
resource will succeed even if errors occur during deletion. This parameter
can be used when you want to delete GCP's node pool resource and you've
already deleted the on-prem admin cluster that hosted your node pool.
WARNING: Using this parameter when your user cluster still exists may
result in a deleted GCP node pool but an existing on-prem node pool.
validateOnly
- If set, only validate the request, but do not actually
delete the node pool.
$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? 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 (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>);
}