com.google.api.services.apigee.v1

Class Apigee.Organizations.Appgroups.Apps

java.lang.Object

com.google.api.services.apigee.v1.Apigee.Organizations.Appgroups.Apps

Enclosing class:

Apigee.Organizations.Appgroups

public class Apigee.Organizations.Appgroups.Apps
extends Object

The "apps" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Appgroups.Apps.Create
class	Apigee.Organizations.Appgroups.Apps.Delete
class	Apigee.Organizations.Appgroups.Apps.Get
class	Apigee.Organizations.Appgroups.Apps.Keys The "keys" collection of methods.
class	Apigee.Organizations.Appgroups.Apps.List
class	Apigee.Organizations.Appgroups.Apps.Update

Constructor Summary

Constructors

Constructor and Description
Apps()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Appgroups.Apps.Create	create(String parent, GoogleCloudApigeeV1AppGroupApp content) Creates an app and associates it with an AppGroup.
Apigee.Organizations.Appgroups.Apps.Delete	delete(String name) Deletes an AppGroup app.
Apigee.Organizations.Appgroups.Apps.Get	get(String name) Returns the details for an AppGroup app.
Apigee.Organizations.Appgroups.Apps.Keys	keys() An accessor for creating requests from the Keys collection.
Apigee.Organizations.Appgroups.Apps.List	list(String parent) Lists all apps created by an AppGroup in an Apigee organization.
Apigee.Organizations.Appgroups.Apps.Update	update(String name, GoogleCloudApigeeV1AppGroupApp content) Updates the details for an AppGroup app.

Methods inherited from class java.lang.Object

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

Constructor Detail

Apps

public Apps()

Method Detail

create

public Apigee.Organizations.Appgroups.Apps.Create create(String parent,
                                                         GoogleCloudApigeeV1AppGroupApp content)
                                                  throws IOException

Creates an app and associates it with an AppGroup. This API associates the AppGroup app with the specified API product and auto-generates an API key for the app to use in calls to API proxies inside that API product. The `name` is the unique ID of the app that you can use in API calls. Create a request for the method "apps.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 AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}`

content - the GoogleCloudApigeeV1AppGroupApp

Returns:

the request

Throws:

IOException

delete

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

Deletes an AppGroup app. **Note**: The delete operation is asynchronous. The AppGroup app is deleted immediately, but its associated resources, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be deleted. Create a request for the method "apps.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 AppGroup app. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}`

Returns:

the request

Throws:

IOException

get

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

Returns the details for an AppGroup app. Create a request for the method "apps.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 AppGroup app. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}`

Returns:

the request

Throws:

IOException

list

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

Lists all apps created by an AppGroup in an Apigee organization. Optionally, you can request an expanded view of the AppGroup apps. Lists all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000. Create a request for the method "apps.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 AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}`

Returns:

the request

Throws:

IOException

update

public Apigee.Organizations.Appgroups.Apps.Update update(String name,
                                                         GoogleCloudApigeeV1AppGroupApp content)
                                                  throws IOException

Updates the details for an AppGroup app. In addition, you can add an API product to an AppGroup app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateAppGroupAppKey API. Using this API, you cannot update the app name, as it is the primary key used to identify the app and cannot be changed. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. Create a request for the method "apps.update". 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 AppGroup app. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}`

content - the GoogleCloudApigeeV1AppGroupApp

Returns:

the request

Throws:

IOException

keys

public Apigee.Organizations.Appgroups.Apps.Keys keys()

An accessor for creating requests from the Keys collection.

The typical use is:

    Apigee apigee = new Apigee(...);
    Apigee.Keys.List request = apigee.keys().list(parameters ...)
 

Returns:

the resource collection