resume method

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

Resume a queue.

This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to RUNNING. WARNING: Resuming many high-QPS queues at the same time can lead to target overloading. If you are resuming high-QPS queues, follow the 500/50/5 pattern described in Managing Cloud Tasks Scaling Risks.

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> resume(
  ResumeQueueRequest 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') + ':resume';

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