com.google.api.services.apigee.v1

Class Apigee.Organizations.Appgroups.Apps.Keys

java.lang.Object

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

Enclosing class:

Apigee.Organizations.Appgroups.Apps

public class Apigee.Organizations.Appgroups.Apps.Keys
extends Object

The "keys" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Appgroups.Apps.Keys.Apiproducts The "apiproducts" collection of methods.
class	Apigee.Organizations.Appgroups.Apps.Keys.Create
class	Apigee.Organizations.Appgroups.Apps.Keys.Delete
class	Apigee.Organizations.Appgroups.Apps.Keys.Get
class	Apigee.Organizations.Appgroups.Apps.Keys.UpdateAppGroupAppKey

Constructor Summary

Constructors

Constructor and Description
Keys()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Appgroups.Apps.Keys.Apiproducts	apiproducts() An accessor for creating requests from the Apiproducts collection.
Apigee.Organizations.Appgroups.Apps.Keys.Create	create(String parent, GoogleCloudApigeeV1AppGroupAppKey content) Creates a custom consumer key and secret for a AppGroup app.
Apigee.Organizations.Appgroups.Apps.Keys.Delete	delete(String name) Deletes an app's consumer key and removes all API products associated with the app.
Apigee.Organizations.Appgroups.Apps.Keys.Get	get(String name) Gets details for a consumer key for a AppGroup app, including the key and secret value, associated API products, and other information.
Apigee.Organizations.Appgroups.Apps.Keys.UpdateAppGroupAppKey	updateAppGroupAppKey(String name, GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest content) Adds an API product to an AppGroupAppKey, enabling the app that holds the key to access the API resources bundled in the API product.

Methods inherited from class java.lang.Object

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

Constructor Detail

Keys

public Keys()

Method Detail

create

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

Creates a custom consumer key and secret for a AppGroup app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateAppGroupAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteAppGroupAppKey API. Create a request for the method "keys.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. Parent of the AppGroup app key. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys`

content - the GoogleCloudApigeeV1AppGroupAppKey

Returns:

the request

Throws:

IOException

delete

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

Deletes an app's consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs. Create a request for the method "keys.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 key. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}`

Returns:

the request

Throws:

IOException

get

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

Gets details for a consumer key for a AppGroup app, including the key and secret value, associated API products, and other information. Create a request for the method "keys.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 key. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}`

Returns:

the request

Throws:

IOException

updateAppGroupAppKey

public Apigee.Organizations.Appgroups.Apps.Keys.UpdateAppGroupAppKey updateAppGroupAppKey(String name,
                                                                                          GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest content)
                                                                                   throws IOException

Adds an API product to an AppGroupAppKey, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes and scopes to the AppGroupAppKey. 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. You can use the same key to access all API products associated with the app. Create a request for the method "keys.updateAppGroupAppKey". 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 key. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}`

content - the GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest

Returns:

the request

Throws:

IOException

apiproducts

public Apigee.Organizations.Appgroups.Apps.Keys.Apiproducts apiproducts()

An accessor for creating requests from the Apiproducts collection.

The typical use is:

    Apigee apigee = new Apigee(...);
    Apigee.Apiproducts.List request = apigee.apiproducts().list(parameters ...)
 

Returns:

the resource collection