cancel method

Future<void> cancel(
  1. String bucket,
  2. String operationId, {
  3. String? $fields,
})

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed.

Request parameters:

bucket - The parent bucket of the operation resource.

operationId - The ID of the operation resource.

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

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<void> cancel(
  core.String bucket,
  core.String operationId, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'b/' +
      commons.escapeVariable('$bucket') +
      '/operations/' +
      commons.escapeVariable('$operationId') +
      '/cancel';

  await _requester.request(
    url_,
    'POST',
    queryParams: queryParams_,
    downloadOptions: null,
  );
}