deleteQueueItems method

Future<Operation> deleteQueueItems(DeleteQueueItemsRequest request, String name, { String? $fields, })

Deletes all items in a queue.

This method is useful for deleting stale items. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

request - The metadata request object.

Request parameters:

name - The name of the Data Source to delete items in a queue. Format: datasources/{source_id} Value must have pattern ^datasources/\[^/\]+$.

$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> deleteQueueItems(
  DeleteQueueItemsRequest 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_ = 'v1/indexing/' +
      core.Uri.encodeFull('$name') +
      '/items:deleteQueueItems';

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