com.google.api.services.apigee.v1

Class Apigee.Organizations.Appgroups

java.lang.Object

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

Enclosing class:

Apigee.Organizations

public class Apigee.Organizations.Appgroups
extends Object

The "appgroups" collection of methods.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Appgroups()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Appgroups.Apps	apps() An accessor for creating requests from the Apps collection.
Apigee.Organizations.Appgroups.Create	create(String parent, GoogleCloudApigeeV1AppGroup content) Creates an AppGroup.
Apigee.Organizations.Appgroups.Delete	delete(String name) Deletes an AppGroup.
Apigee.Organizations.Appgroups.Get	get(String name) Returns the AppGroup details for the provided AppGroup name in the request URI.
Apigee.Organizations.Appgroups.List	list(String parent) Lists all AppGroups in an organization.
Apigee.Organizations.Appgroups.Update	update(String name, GoogleCloudApigeeV1AppGroup content) Updates an AppGroup.

Methods inherited from class java.lang.Object

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

Constructor Detail

Appgroups

public Appgroups()

Method Detail

create

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

Creates an AppGroup. Once created, user can register apps under the AppGroup to obtain secret key and password. At creation time, the AppGroup's state is set as `active`. Create a request for the method "appgroups.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 Apigee organization in which the AppGroup is created. Use the following structure in your request: `organizations/{org}`.

content - the GoogleCloudApigeeV1AppGroup

Returns:

the request

Throws:

IOException

delete

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

Deletes an AppGroup. All app and API keys associations with the AppGroup are also removed. **Warning**: This API will permanently delete the AppGroup and related artifacts. **Note**: The delete operation is asynchronous. The AppGroup is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted. Create a request for the method "appgroups.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. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}`

Returns:

the request

Throws:

IOException

get

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

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

Returns:

the request

Throws:

IOException

list

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

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

Returns:

the request

Throws:

IOException

update

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

Updates an AppGroup. This API replaces the existing AppGroup details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. Note that the state of the AppGroup should be updated using `action`, and not via AppGroup. Create a request for the method "appgroups.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. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}`

content - the GoogleCloudApigeeV1AppGroup

Returns:

the request

Throws:

IOException

apps

public Apigee.Organizations.Appgroups.Apps apps()

An accessor for creating requests from the Apps collection.

The typical use is:

    Apigee apigee = new Apigee(...);
    Apigee.Apps.List request = apigee.apps().list(parameters ...)
 

Returns:

the resource collection