com.google.api.services.apigee.v1

Class Apigee.Organizations.Environments.Apis.Revisions.Deployments

java.lang.Object

com.google.api.services.apigee.v1.Apigee.Organizations.Environments.Apis.Revisions.Deployments

Enclosing class:

Apigee.Organizations.Environments.Apis.Revisions

public class Apigee.Organizations.Environments.Apis.Revisions.Deployments
extends Object

The "deployments" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport
class	Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport

Constructor Summary

Constructors

Constructor and Description
Deployments()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport	generateDeployChangeReport(String name) Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport	generateUndeployChangeReport(String name) Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Deployments

public Deployments()

Method Detail

generateDeployChangeReport

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport generateDeployChangeReport(String name)
                                                                                                                   throws IOException

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}` Create a request for the method "deployments.generateDeployChangeReport". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api- platform/system-administration/spaces/apigee-spaces-overview).

Returns:

the request

Throws:

IOException

generateUndeployChangeReport

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport generateUndeployChangeReport(String name)
                                                                                                                       throws IOException

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}` Create a request for the method "deployments.generateUndeployChangeReport". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException