stop method

Future<ScanRun> stop(
  1. StopScanRunRequest request,
  2. String name, {
  3. String? $fields,
})

Stops a ScanRun.

The stopped ScanRun is returned.

request - The metadata request object.

Request parameters:

name - Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. Value must have pattern ^projects/\[^/\]+/scanConfigs/\[^/\]+/scanRuns/\[^/\]+$.

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

Completes with a ScanRun.

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<ScanRun> stop(
  StopScanRunRequest 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') + ':stop';

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