delete method

Future<Operation> delete(
  1. String project,
  2. String deployment, {
  3. String? deletePolicy,
  4. String? $fields,
})

Deletes a deployment and all of the resources in the deployment.

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.

deletePolicy - Sets the policy to use for deleting resources. Possible string values are:

  • "DELETE"
  • "ABANDON"

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

  final url_ = 'deploymentmanager/v2/projects/' +
      commons.escapeVariable('$project') +
      '/global/deployments/' +
      commons.escapeVariable('$deployment');

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