generateDeployChangeReport method

Future<GoogleCloudApigeeV1DeploymentChangeReport> generateDeployChangeReport(
  1. String name, {
  2. bool? override,
  3. String? $fields,
})

Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment.

In addition to the standard validations performed when adding deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being created. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run DeployApiProxy request. For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport, two permissions are required: * apigee.deployments.create on the resource organizations/{org}/environments/{env} * apigee.proxyrevisions.deploy 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/\[^/\]+$.

override - Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks.

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

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

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