stop method

Future<Operation> stop(DeploymentsStopRequest request, String project, String deployment, { String? $fields, })

Stops an ongoing operation.

This does not roll back any work that has already been completed, but prevents any new work from being started.

request - The metadata request object.

Request parameters:

project - The project ID for this request. Value must have pattern (?:(?:\[-a-z0-9\]{1,63}\.)*(?:\[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?):)?(?:\[0-9\]{1,19}|(?:\[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?)).

deployment - The name of the deployment for this request. Value must have pattern \[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?.

$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> stop(
  DeploymentsStopRequest request,
  core.String project,
  core.String deployment, {
  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_ = 'deploymentmanager/v2/projects/' +
      commons.escapeVariable('$project') +
      '/global/deployments/' +
      commons.escapeVariable('$deployment') +
      '/stop';

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