delete method
Deletes an existing subscription.
All messages retained in the subscription are immediately dropped. Calls
to Pull
after deletion will return NOT_FOUND
. After a subscription is
deleted, a new one may be created with the same name, but the new one has
no association with the old subscription or its topic unless the same
topic is specified.
Request parameters:
subscription
- Required. The subscription to delete. Format is
projects/{project}/subscriptions/{sub}
.
Value must have pattern ^projects/\[^/\]+/subscriptions/\[^/\]+$
.
$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 subscription, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$subscription');
final response_ = await _requester.request(
url_,
'DELETE',
queryParams: queryParams_,
);
return Empty.fromJson(response_ as core.Map<core.String, core.dynamic>);
}