generateUndeployChangeReport method

Future<GoogleCloudApigeeV1DeploymentChangeReport> generateUndeployChangeReport(
  1. String name, {
  2. String? $fields,
})

Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy.

In addition to the standard validations performed when removing deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being removed. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run UndeployApiProxy request. For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport, two permissions are required: * apigee.deployments.delete on the resource organizations/{org}/environments/{env} * apigee.proxyrevisions.undeploy on the resource organizations/{org}/apis/{api}/revisions/{rev}

Request parameters:

name - Name of the API proxy revision deployment in the following format: organizations/{org}/environments/{env}/apis/{api}/revisions/{rev} Value must have pattern ^organizations/\[^/\]+/environments/\[^/\]+/apis/\[^/\]+/revisions/\[^/\]+$.

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

Completes with a GoogleCloudApigeeV1DeploymentChangeReport.

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

  final url_ = 'v1/' +
      core.Uri.encodeFull('$name') +
      '/deployments:generateUndeployChangeReport';

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