class OrganizationsEnvironmentsApisRevisionsDeployments extends Resource (View source)

The "deployments" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $deployments = $apigeeService->organizations_environments_apis_revisions_deployments;

Methods

generateDeployChangeReport(string $name, array $optParams = [])

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.

generateUndeployChangeReport(string $name, array $optParams = [])

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/{or g}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeploy ChangeReport, 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} (deployments.generateUndeployChangeReport)

Details

GoogleCloudApigeeV1DeploymentChangeReport generateDeployChangeReport(string $name, array $optParams = [])

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} (deployments.generateDeployChangeReport)

Parameters

string $name

Name of the API proxy revision deployment in the following format: organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1DeploymentChangeReport

Exceptions

Exception

GoogleCloudApigeeV1DeploymentChangeReport generateUndeployChangeReport(string $name, array $optParams = [])

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/{or g}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeploy ChangeReport, 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} (deployments.generateUndeployChangeReport)

Parameters

string $name

Name of the API proxy revision deployment in the following format: organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1DeploymentChangeReport

Exceptions

Exception