com.google.api.services.apigee.v1

Class Apigee.Organizations.Apis

java.lang.Object

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

Enclosing class:

Apigee.Organizations

public class Apigee.Organizations.Apis
extends Object

The "apis" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Apis.Create
class	Apigee.Organizations.Apis.Debugsessions The "debugsessions" collection of methods.
class	Apigee.Organizations.Apis.Delete
class	Apigee.Organizations.Apis.Deployments The "deployments" collection of methods.
class	Apigee.Organizations.Apis.Get
class	Apigee.Organizations.Apis.Keyvaluemaps The "keyvaluemaps" collection of methods.
class	Apigee.Organizations.Apis.List
class	Apigee.Organizations.Apis.Move
class	Apigee.Organizations.Apis.Patch
class	Apigee.Organizations.Apis.Revisions The "revisions" collection of methods.

Constructor Summary

Constructors

Constructor and Description
Apis()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Apis.Create	create(String parent, GoogleApiHttpBody content) Creates an API proxy.
Apigee.Organizations.Apis.Debugsessions	debugsessions() An accessor for creating requests from the Debugsessions collection.
Apigee.Organizations.Apis.Delete	delete(String name) Deletes an API proxy and all associated endpoints, policies, resources, and revisions.
Apigee.Organizations.Apis.Deployments	deployments() An accessor for creating requests from the Deployments collection.
Apigee.Organizations.Apis.Get	get(String name) Gets an API proxy including a list of existing revisions.
Apigee.Organizations.Apis.Keyvaluemaps	keyvaluemaps() An accessor for creating requests from the Keyvaluemaps collection.
Apigee.Organizations.Apis.List	list(String parent) Lists the names of all API proxies in an organization.
Apigee.Organizations.Apis.Move	move(String name, GoogleCloudApigeeV1MoveApiProxyRequest content) Moves an API proxy to a different space.
Apigee.Organizations.Apis.Patch	patch(String name, GoogleCloudApigeeV1ApiProxy content) Updates an existing API proxy.
Apigee.Organizations.Apis.Revisions	revisions() An accessor for creating requests from the Revisions collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

Apis

public Apis()

Method Detail

create

public Apigee.Organizations.Apis.Create create(String parent,
                                               GoogleApiHttpBody content)
                                        throws IOException

Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the `name` query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: * Set the `name` query parameter to the name of the API proxy. * Set the `action` query parameter to `import`. * Set the `Content- Type` header to `multipart/form-data`. * Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the `file` form field. **Note**: To validate the API proxy configuration bundle only without importing it, set the `action` query parameter to `validate`. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client. Create a request for the method "apis.create". 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:

parent - Required. Name of the organization in the following format: `organizations/{org}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview).

content - the GoogleApiHttpBody

Returns:

the request

Throws:

IOException

delete

public Apigee.Organizations.Apis.Delete delete(String name)
                                        throws IOException

Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be undeployed before you can delete it. Create a request for the method "apis.delete". 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 in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. 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

get

public Apigee.Organizations.Apis.Get get(String name)
                                  throws IOException

Gets an API proxy including a list of existing revisions. Create a request for the method "apis.get". 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 in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. 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

list

public Apigee.Organizations.Apis.List list(String parent)
                                    throws IOException

Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee- spaces-overview). Create a request for the method "apis.list". 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:

parent - Required. Name of the organization in the following format: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. 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

move

public Apigee.Organizations.Apis.Move move(String name,
                                           GoogleCloudApigeeV1MoveApiProxyRequest content)
                                    throws IOException

Moves an API proxy to a different space. Create a request for the method "apis.move". 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. API proxy to move in the following format: `organizations/{org}/apis/{api}`

content - the GoogleCloudApigeeV1MoveApiProxyRequest

Returns:

the request

Throws:

IOException

patch

public Apigee.Organizations.Apis.Patch patch(String name,
                                             GoogleCloudApigeeV1ApiProxy content)
                                      throws IOException

Updates an existing API proxy. Create a request for the method "apis.patch". 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. API proxy to update in the following format: `organizations/{org}/apis/{api}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview).

content - the GoogleCloudApigeeV1ApiProxy

Returns:

the request

Throws:

IOException

debugsessions

public Apigee.Organizations.Apis.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.Apis.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

keyvaluemaps

public Apigee.Organizations.Apis.Keyvaluemaps keyvaluemaps()

An accessor for creating requests from the Keyvaluemaps collection.

The typical use is:

    Apigee apigee = new Apigee(...);
    Apigee.Keyvaluemaps.List request = apigee.keyvaluemaps().list(parameters ...)
 

Returns:

the resource collection

revisions

public Apigee.Organizations.Apis.Revisions revisions()

An accessor for creating requests from the Revisions collection.

The typical use is:

    Apigee apigee = new Apigee(...);
    Apigee.Revisions.List request = apigee.revisions().list(parameters ...)
 

Returns:

the resource collection