com.google.api.services.apigee.v1

Class Apigee.Organizations.Developers.Apps.Keys

java.lang.Object

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

Enclosing class:

Apigee.Organizations.Developers.Apps

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

The "keys" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Developers.Apps.Keys.Apiproducts The "apiproducts" collection of methods.
class	Apigee.Organizations.Developers.Apps.Keys.Create The "create" collection of methods.
class	Apigee.Organizations.Developers.Apps.Keys.CreateRequest
class	Apigee.Organizations.Developers.Apps.Keys.Delete
class	Apigee.Organizations.Developers.Apps.Keys.Get
class	Apigee.Organizations.Developers.Apps.Keys.ReplaceDeveloperAppKey
class	Apigee.Organizations.Developers.Apps.Keys.UpdateDeveloperAppKey

Constructor Summary

Constructors

Constructor and Description
Keys()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Developers.Apps.Keys.Apiproducts	apiproducts() An accessor for creating requests from the Apiproducts collection.
Apigee.Organizations.Developers.Apps.Keys.Create	create() An accessor for creating requests from the Create collection.
Apigee.Organizations.Developers.Apps.Keys.CreateRequest	create(String parent, GoogleCloudApigeeV1DeveloperAppKey content) Creates a custom consumer key and secret for a developer app.
Apigee.Organizations.Developers.Apps.Keys.Delete	delete(String name) Deletes an app's consumer key and removes all API products associated with the app.
Apigee.Organizations.Developers.Apps.Keys.Get	get(String name) Gets details for a consumer key for a developer app, including the key and secret value, associated API products, and other information.
Apigee.Organizations.Developers.Apps.Keys.ReplaceDeveloperAppKey	replaceDeveloperAppKey(String name, GoogleCloudApigeeV1DeveloperAppKey content) Updates the scope of an app.
Apigee.Organizations.Developers.Apps.Keys.UpdateDeveloperAppKey	updateDeveloperAppKey(String name, GoogleCloudApigeeV1DeveloperAppKey content) Adds an API product to a developer app key, 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.Developers.Apps.Keys.CreateRequest create(String parent,
                                                                      GoogleCloudApigeeV1DeveloperAppKey content)
                                                               throws IOException

Creates a custom consumer key and secret for a developer 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 UpdateDeveloperAppKey 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 DeleteDeveloperAppKey API. **Note**: All keys start out with status=approved, even if status=revoked is passed when the key is created. To revoke a key, use the UpdateDeveloperAppKey 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 - Parent of the developer app key. Use the following structure in your request: 'organizations/{org}/developers/{developerEmail}/apps/{appName}'

content - the GoogleCloudApigeeV1DeveloperAppKey

Returns:

the request

Throws:

IOException

delete

public Apigee.Organizations.Developers.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. **Note**: After you delete a consumer key, you may want to: 1. Create a new consumer key and secret for the developer app using the CreateDeveloperAppKey API, and subsequently add an API product to the key using the UpdateDeveloperAppKey API. 2. Delete the developer app, if it is no longer required. 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 - Name of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`

Returns:

the request

Throws:

IOException

get

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

Gets details for a consumer key for a developer 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 - Name of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`

Returns:

the request

Throws:

IOException

replaceDeveloperAppKey

public Apigee.Organizations.Developers.Apps.Keys.ReplaceDeveloperAppKey replaceDeveloperAppKey(String name,
                                                                                               GoogleCloudApigeeV1DeveloperAppKey content)
                                                                                        throws IOException

Updates the scope of an app. This API replaces the existing scopes with those specified in the request. Include or exclude any existing scopes that you want to retain or delete, respectively. The specified scopes must already be defined for the API products associated with the app. This API sets the `scopes` element under the `apiProducts` element in the attributes of the app. Create a request for the method "keys.replaceDeveloperAppKey". 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 - Name of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`

content - the GoogleCloudApigeeV1DeveloperAppKey

Returns:

the request

Throws:

IOException

updateDeveloperAppKey

public Apigee.Organizations.Developers.Apps.Keys.UpdateDeveloperAppKey updateDeveloperAppKey(String name,
                                                                                             GoogleCloudApigeeV1DeveloperAppKey content)
                                                                                      throws IOException

Adds an API product to a developer app key, 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 associated with the API product to the developer app key. The status of the key can be updated via "action" Query Parameter. None of the other fields can be updated via this API. 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. None of the other fields can be updated. You can use the same key to access all API products associated with the app. Create a request for the method "keys.updateDeveloperAppKey". 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 - Name of the developer app key. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}`

content - the GoogleCloudApigeeV1DeveloperAppKey

Returns:

the request

Throws:

IOException

apiproducts

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

create

public Apigee.Organizations.Developers.Apps.Keys.Create create()

An accessor for creating requests from the Create collection.

The typical use is:

    Apigee apigee = new Apigee(...);
    Apigee.Create.List request = apigee.create().list(parameters ...)
 

Returns:

the resource collection