cancel method

Future<Empty> cancel(CancelOperationRequest request, String projectId, String zone, String operationId, { String? $fields, })

Cancels the specified operation.

request - The metadata request object.

Request parameters:

projectId - Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone - Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.

operationId - Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field.

$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> cancel(
  CancelOperationRequest request,
  core.String projectId,
  core.String zone,
  core.String operationId, {
  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/projects/' +
      commons.escapeVariable('$projectId') +
      '/zones/' +
      commons.escapeVariable('$zone') +
      '/operations/' +
      commons.escapeVariable('$operationId') +
      ':cancel';

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