purge method

Future<Queue> purge(
  1. PurgeQueueRequest request,
  2. String name, {
  3. String? $fields,
})

Purges a queue by deleting all of its tasks.

All tasks created before this method is called are permanently deleted. Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible.

request - The metadata request object.

Request parameters:

name - Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/queues/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a Queue.

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<Queue> purge(
  PurgeQueueRequest request,
  core.String name, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v2/' + core.Uri.encodeFull('$name') + ':purge';

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