delete method
Deletes the cluster, including the Kubernetes endpoint and all worker nodes.
Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.
Request parameters:
name
- The name (project, location, cluster) of the cluster to delete.
Specified in the format projects / * /locations / * /clusters / *
.
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/clusters/\[^/\]+$
.
clusterId
- Deprecated. The name of the cluster to delete. This field
has been deprecated and replaced by the name field.
projectId
- Deprecated. The Google Developers Console
project ID or project number.
This field has been deprecated and replaced by the name field.
zone
- Deprecated. The name of the Google Compute Engine
zone in which the
cluster resides. This field has been deprecated and replaced by the name
field.
$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? clusterId,
core.String? projectId,
core.String? zone,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (clusterId != null) 'clusterId': [clusterId],
if (projectId != null) 'projectId': [projectId],
if (zone != null) 'zone': [zone],
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>);
}