com.google.api.services.apigee.v1

Class Apigee.Organizations.Environments.Apis.Revisions

java.lang.Object

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

Enclosing class:

Apigee.Organizations.Environments.Apis

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

The "revisions" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Environments.Apis.Revisions.Debugsessions The "debugsessions" collection of methods.
class	Apigee.Organizations.Environments.Apis.Revisions.Deploy
class	Apigee.Organizations.Environments.Apis.Revisions.Deployments The "deployments" collection of methods.
class	Apigee.Organizations.Environments.Apis.Revisions.GetDeployments
class	Apigee.Organizations.Environments.Apis.Revisions.Undeploy

Constructor Summary

Constructors

Constructor and Description
Revisions()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Environments.Apis.Revisions.Debugsessions	debugsessions() An accessor for creating requests from the Debugsessions collection.
Apigee.Organizations.Environments.Apis.Revisions.Deploy	deploy(String name) Deploys a revision of an API proxy.
Apigee.Organizations.Environments.Apis.Revisions.Deployments	deployments() An accessor for creating requests from the Deployments collection.
Apigee.Organizations.Environments.Apis.Revisions.GetDeployments	getDeployments(String name) Gets the deployment of an API proxy revision and actual state reported by runtime pods.
Apigee.Organizations.Environments.Apis.Revisions.Undeploy	undeploy(String name) Undeploys an API proxy revision from an environment.

Methods inherited from class java.lang.Object

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

Constructor Detail

Revisions

public Revisions()

Method Detail

deploy

public Apigee.Organizations.Environments.Apis.Revisions.Deploy deploy(String name)
                                                               throws IOException

Deploys a revision of an API proxy. If another revision of the same API proxy revision is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, 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}` All successful API proxy deployments to Apigee are [zero-downtime deployments](https://cloud.google.com/apigee/docs/api-platform/deploy/ui- deploy-overview#zero-downtime-deployment). Apigee hybrid validates the dependencies between shared flows and API proxies at deployment time. For example, if the Flow Callout policy in an API proxy references a shared flow that either doesn't exist or isn't deployed, the API proxy deployment fails. Create a request for the method "revisions.deploy". 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 - Required. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource being deployed 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

getDeployments

public Apigee.Organizations.Environments.Apis.Revisions.GetDeployments getDeployments(String name)
                                                                               throws IOException

Gets the deployment of an API proxy revision and actual state reported by runtime pods. Create a request for the method "revisions.getDeployments". 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 - Required. Name representing an API proxy revision in an environment 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

undeploy

public Apigee.Organizations.Environments.Apis.Revisions.Undeploy undeploy(String name)
                                                                   throws IOException

Undeploys an API proxy revision from an environment. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, 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 "revisions.undeploy". 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 - Required. 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

debugsessions

public Apigee.Organizations.Environments.Apis.Revisions.Debugsessions debugsessions()

An accessor for creating requests from the Debugsessions collection.

The typical use is:

    Apigee apigee = new Apigee(...);
    Apigee.Debugsessions.List request = apigee.debugsessions().list(parameters ...)
 

Returns:

the resource collection

deployments

public Apigee.Organizations.Environments.Apis.Revisions.Deployments deployments()

An accessor for creating requests from the Deployments collection.

The typical use is:

    Apigee apigee = new Apigee(...);
    Apigee.Deployments.List request = apigee.deployments().list(parameters ...)
 

Returns:

the resource collection