cancel method

Future<CancelAutomationRunResponse> cancel(
  1. CancelAutomationRunRequest request,
  2. String name, {
  3. String? $fields,
})

Cancels an AutomationRun.

The state of the AutomationRun after cancelling is CANCELLED. CancelAutomationRun can be called on AutomationRun in the state IN_PROGRESS and PENDING; AutomationRun in a different state returns an FAILED_PRECONDITION error.

request - The metadata request object.

Request parameters:

name - Required. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/deliveryPipelines/\[^/\]+/automationRuns/\[^/\]+$.

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

Completes with a CancelAutomationRunResponse.

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<CancelAutomationRunResponse> cancel(
  CancelAutomationRunRequest 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/' + core.Uri.encodeFull('$name') + ':cancel';

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