delete method
Developer Preview: Deletes a Google Workspace subscription.
To learn how to use this method, see Delete a Google Workspace subscription.
Request parameters:
name
- Required. Resource name of the subscription to delete. Format:
subscriptions/{subscription}
Value must have pattern ^subscriptions/\[^/\]+$
.
allowMissing
- Optional. If set to true
and the subscription isn't
found, the request succeeds but doesn't delete the subscription.
etag
- Optional. Etag of the subscription. If present, it must match
with the server's etag. Otherwise, request fails with the status
ABORTED
.
validateOnly
- Optional. If set to true
, validates and previews the
request, but doesn't delete the subscription.
$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.bool? allowMissing,
core.String? etag,
core.bool? validateOnly,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (allowMissing != null) 'allowMissing': ['${allowMissing}'],
if (etag != null) 'etag': [etag],
if (validateOnly != null) 'validateOnly': ['${validateOnly}'],
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>);
}