com.google.api.services.apigee.v1

Class Apigee.Organizations.Developers.Apps

java.lang.Object

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

Enclosing class:

Apigee.Organizations.Developers

public class Apigee.Organizations.Developers.Apps
extends Object

The "apps" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Developers.Apps.Attributes The "attributes" collection of methods.
class	Apigee.Organizations.Developers.Apps.AttributesRequest
class	Apigee.Organizations.Developers.Apps.Create
class	Apigee.Organizations.Developers.Apps.Delete
class	Apigee.Organizations.Developers.Apps.GenerateKeyPairOrUpdateDeveloperAppStatus
class	Apigee.Organizations.Developers.Apps.Get
class	Apigee.Organizations.Developers.Apps.Keys The "keys" collection of methods.
class	Apigee.Organizations.Developers.Apps.List
class	Apigee.Organizations.Developers.Apps.Update

Constructor Summary

Constructors

Constructor and Description
Apps()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Developers.Apps.Attributes	attributes() An accessor for creating requests from the Attributes collection.
Apigee.Organizations.Developers.Apps.AttributesRequest	attributes(String name, GoogleCloudApigeeV1Attributes content) Updates attributes for a developer app.
Apigee.Organizations.Developers.Apps.Create	create(String parent, GoogleCloudApigeeV1DeveloperApp content) Creates an app associated with a developer.
Apigee.Organizations.Developers.Apps.Delete	delete(String name) Deletes a developer app.
Apigee.Organizations.Developers.Apps.GenerateKeyPairOrUpdateDeveloperAppStatus	generateKeyPairOrUpdateDeveloperAppStatus(String name, GoogleCloudApigeeV1DeveloperApp content) Manages access to a developer app by enabling you to: * Approve or revoke a developer app * Generate a new consumer key and secret for a developer app To approve or revoke a developer app, set the `action` query parameter to `approve` or `revoke`, respectively, and the `Content-Type` header to `application/octet-stream`.
Apigee.Organizations.Developers.Apps.Get	get(String name) Returns the details for a developer app.
Apigee.Organizations.Developers.Apps.Keys	keys() An accessor for creating requests from the Keys collection.
Apigee.Organizations.Developers.Apps.List	list(String parent) Lists all apps created by a developer in an Apigee organization.
Apigee.Organizations.Developers.Apps.Update	update(String name, GoogleCloudApigeeV1DeveloperApp content) Updates the details for a developer 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

attributes

public Apigee.Organizations.Developers.Apps.AttributesRequest attributes(String name,
                                                                         GoogleCloudApigeeV1Attributes content)
                                                                  throws IOException

Updates attributes for a developer app. This API replaces the current attributes with those specified in the request. Create a request for the method "apps.attributes". 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 developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}`

content - the GoogleCloudApigeeV1Attributes

Returns:

the request

Throws:

IOException

create

public Apigee.Organizations.Developers.Apps.Create create(String parent,
                                                          GoogleCloudApigeeV1DeveloperApp content)
                                                   throws IOException

Creates an app associated with a developer. This API associates the developer 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. The `DisplayName` (set as an attribute) appears in the UI. If you don't set the `DisplayName` attribute, the `name` appears in the UI. 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 developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`

content - the GoogleCloudApigeeV1DeveloperApp

Returns:

the request

Throws:

IOException

delete

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

Deletes a developer app. **Note**: The delete operation is asynchronous. The developer 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 developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}`

Returns:

the request

Throws:

IOException

generateKeyPairOrUpdateDeveloperAppStatus

public Apigee.Organizations.Developers.Apps.GenerateKeyPairOrUpdateDeveloperAppStatus generateKeyPairOrUpdateDeveloperAppStatus(String name,
                                                                                                                                GoogleCloudApigeeV1DeveloperApp content)
                                                                                                                         throws IOException

Manages access to a developer app by enabling you to: * Approve or revoke a developer app * Generate a new consumer key and secret for a developer app To approve or revoke a developer app, set the `action` query parameter to `approve` or `revoke`, respectively, and the `Content-Type` header to `application/octet-stream`. If a developer app is revoked, none of its API keys are valid for API calls even though the keys are still approved. If successful, the API call returns the following HTTP status code: `204 No Content` To generate a new consumer key and secret for a developer app, pass the new key/secret details. Rather than replace an existing key, this API generates a new key. In this case, multiple key pairs may be associated with a single developer app. Each key pair has an independent status (`approve` or `revoke`) and expiration time. Any approved, non-expired key can be used in an API call. For example, if you're using API key rotation, you can generate new keys with expiration times that overlap keys that are going to expire. You might also generate a new consumer key/secret if the security of the original key/secret is compromised. The `keyExpiresIn` property defines the expiration time for the API key in milliseconds. If you don't set this property or set it to `-1`, the API key never expires. **Notes**: * When generating a new key/secret, this API replaces the existing attributes, notes, and callback URLs with those specified in the request. Include or exclude any existing information that you want to retain or delete, respectively. * To migrate existing consumer keys and secrets to hybrid from another system, see the CreateDeveloperAppKey API. Create a request for the method "apps.generateKeyPairOrUpdateDeveloperAppStatus". 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 developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}`

content - the GoogleCloudApigeeV1DeveloperApp

Returns:

the request

Throws:

IOException

get

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

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

Returns:

the request

Throws:

IOException

list

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

Lists all apps created by a developer in an Apigee organization. Optionally, you can request an expanded view of the developer apps. A maximum of 100 developer apps are returned per API call. You can paginate the list of deveoper apps returned using the `startKey` and `count` query parameters. 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 developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`

Returns:

the request

Throws:

IOException

update

public Apigee.Organizations.Developers.Apps.Update update(String name,
                                                          GoogleCloudApigeeV1DeveloperApp content)
                                                   throws IOException

Updates the details for a developer app. In addition, you can add an API product to a developer 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 UpdateDeveloperAppKey API. Using this API, you cannot update the following: * App name as it is the primary key used to identify the app and cannot be changed. * Scopes associated with the app. Instead, use the ReplaceDeveloperAppKey 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. 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 developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}`

content - the GoogleCloudApigeeV1DeveloperApp

Returns:

the request

Throws:

IOException

attributes

public Apigee.Organizations.Developers.Apps.Attributes attributes()

An accessor for creating requests from the Attributes collection.

The typical use is:

    Apigee apigee = new Apigee(...);
    Apigee.Attributes.List request = apigee.attributes().list(parameters ...)
 

Returns:

the resource collection

keys

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