delete method
Deletes an existing group.
Request parameters:
name
- Required. The group to delete. The format is:
projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
Value must have pattern ^projects/\[^/\]+/groups/\[^/\]+$
.
recursive
- If this field is true, then the request means to delete a
group with all its descendants. Otherwise, the request means to delete a
group only when it has no descendants. The default value is false.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a Empty.
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<Empty> delete(
core.String name, {
core.bool? recursive,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (recursive != null) 'recursive': ['${recursive}'],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v3/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'DELETE',
queryParams: queryParams_,
);
return Empty.fromJson(response_ as core.Map<core.String, core.dynamic>);
}