delete method
Deletes an API key.
Deleted key can be retrieved within 30 days of deletion. Afterward, key
will be purged from the project. NOTE: Key is a global resource; hence the
only supported value for location is global
.
Request parameters:
name
- Required. The resource name of the API key to be deleted.
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/keys/\[^/\]+$
.
etag
- Optional. The etag known to the client for the expected state of
the key. This is to be used for optimistic concurrency.
$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.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (etag != null) 'etag': [etag],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'DELETE',
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}