delete method

Future<Operation> delete(
  1. String name, {
  2. String? etag,
  3. bool? validateOnly,
  4. String? $fields,
})

Deletes a TagKey.

The TagKey cannot be deleted if it has any child TagValues.

Request parameters:

name - Required. The resource name of a TagKey to be deleted in the format tagKeys/123. The TagKey cannot be a parent of any existing TagValues or it will not be deleted successfully. Value must have pattern ^tagKeys/\[^/\]+$.

etag - Optional. The etag known to the client for the expected state of the TagKey. This is to be used for optimistic concurrency.

validateOnly - Optional. Set as true to perform validations necessary for deletion, but not actually perform the action.

$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.bool? validateOnly,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (etag != null) 'etag': [etag],
    if (validateOnly != null) 'validateOnly': ['${validateOnly}'],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v3/' + core.Uri.encodeFull('$name');

  final response_ = await _requester.request(
    url_,
    'DELETE',
    queryParams: queryParams_,
  );
  return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}