delete method
Deletes the provided worker pool.
This will cause the WorkerPool to stop all instances and will delete all associated WorkerPoolRevisions.
Request parameters:
name
- Required. The fully qualified name of the worker pool to delete.
It can be any of the following forms: *
namespaces/{project_id_or_number}/workerpools/{worker_pool_name}
(only
when the endpoint
is regional) *
projects/{project_id_or_number}/locations/{region}/workerpools/{worker_pool_name}
*
projects/{project_id_or_number}/regions/{region}/workerpools/{worker_pool_name}
Value must have pattern ^namespaces/\[^/\]+/workerpools/\[^/\]+$
.
dryRun
- Indicates that the server should validate the request and
populate default values without persisting the request. Supported values:
all
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a Status.
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<Status> delete(
core.String name, {
core.String? dryRun,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (dryRun != null) 'dryRun': [dryRun],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'apis/run.googleapis.com/v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'DELETE',
queryParams: queryParams_,
);
return Status.fromJson(response_ as core.Map<core.String, core.dynamic>);
}