com.google.api.services.apigee.v1

Class Apigee.Organizations.Developers

java.lang.Object

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

Enclosing class:

Apigee.Organizations

public class Apigee.Organizations.Developers
extends Object

The "developers" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Developers.Apps The "apps" collection of methods.
class	Apigee.Organizations.Developers.Attributes The "attributes" collection of methods.
class	Apigee.Organizations.Developers.AttributesRequest
class	Apigee.Organizations.Developers.Balance The "balance" collection of methods.
class	Apigee.Organizations.Developers.Create
class	Apigee.Organizations.Developers.Delete
class	Apigee.Organizations.Developers.Get
class	Apigee.Organizations.Developers.GetBalance
class	Apigee.Organizations.Developers.GetMonetizationConfig
class	Apigee.Organizations.Developers.List
class	Apigee.Organizations.Developers.SetDeveloperStatus
class	Apigee.Organizations.Developers.Subscriptions The "subscriptions" collection of methods.
class	Apigee.Organizations.Developers.Update
class	Apigee.Organizations.Developers.UpdateMonetizationConfig

Constructor Summary

Constructors

Constructor and Description
Developers()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Developers.Apps	apps() An accessor for creating requests from the Apps collection.
Apigee.Organizations.Developers.Attributes	attributes() An accessor for creating requests from the Attributes collection.
Apigee.Organizations.Developers.AttributesRequest	attributes(String parent, GoogleCloudApigeeV1Attributes content) Updates developer attributes.
Apigee.Organizations.Developers.Balance	balance() An accessor for creating requests from the Balance collection.
Apigee.Organizations.Developers.Create	create(String parent, GoogleCloudApigeeV1Developer content) Creates a developer.
Apigee.Organizations.Developers.Delete	delete(String name) Deletes a developer.
Apigee.Organizations.Developers.Get	get(String name) Returns the developer details, including the developer's name, email address, apps, and other information.
Apigee.Organizations.Developers.GetBalance	getBalance(String name) Gets the account balance for the developer.
Apigee.Organizations.Developers.GetMonetizationConfig	getMonetizationConfig(String name) Gets the monetization configuration for the developer.
Apigee.Organizations.Developers.List	list(String parent) Lists all developers in an organization by email address.
Apigee.Organizations.Developers.SetDeveloperStatus	setDeveloperStatus(String name) Sets the status of a developer.
Apigee.Organizations.Developers.Subscriptions	subscriptions() An accessor for creating requests from the Subscriptions collection.
Apigee.Organizations.Developers.Update	update(String name, GoogleCloudApigeeV1Developer content) Updates a developer.
Apigee.Organizations.Developers.UpdateMonetizationConfig	updateMonetizationConfig(String name, GoogleCloudApigeeV1DeveloperMonetizationConfig content) Updates the monetization configuration for the developer.

Methods inherited from class java.lang.Object

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

Constructor Detail

Developers

public Developers()

Method Detail

attributes

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

Updates developer attributes. This API replaces the existing attributes with those specified in the request. Add new attributes, and include or exclude any existing attributes that you want to retain or remove, respectively. The custom attribute limit is 18. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. Create a request for the method "developers.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:

parent - Required. Email address of the developer for which attributes are being updated. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`

content - the GoogleCloudApigeeV1Attributes

Returns:

the request

Throws:

IOException

create

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

Creates a developer. Once created, the developer can register an app and obtain an API key. At creation time, a developer is set as `active`. To change the developer status, use the SetDeveloperStatus API. Create a request for the method "developers.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 developer is created. Use the following structure in your request: `organizations/{org}`.

content - the GoogleCloudApigeeV1Developer

Returns:

the request

Throws:

IOException

delete

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

Deletes a developer. All apps and API keys associated with the developer are also removed. **Warning**: This API will permanently delete the developer and related artifacts. To avoid permanently deleting developers and their artifacts, set the developer status to `inactive` using the SetDeveloperStatus API. **Note**: The delete operation is asynchronous. The developer 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 "developers.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. Email address of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`

Returns:

the request

Throws:

IOException

get

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

Returns the developer details, including the developer's name, email address, apps, and other information. **Note**: The response includes only the first 100 developer apps. Create a request for the method "developers.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. Email address of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`

Returns:

the request

Throws:

IOException

getBalance

public Apigee.Organizations.Developers.GetBalance getBalance(String name)
                                                      throws IOException

Gets the account balance for the developer. Create a request for the method "developers.getBalance". 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. Account balance for the developer. Use the following structure in your request: `organizations/{org}/developers/{developer}/balance`

Returns:

the request

Throws:

IOException

getMonetizationConfig

public Apigee.Organizations.Developers.GetMonetizationConfig getMonetizationConfig(String name)
                                                                            throws IOException

Gets the monetization configuration for the developer. Create a request for the method "developers.getMonetizationConfig". 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. Monetization configuration for the developer. Use the following structure in your request: `organizations/{org}/developers/{developer}/monetizationConfig`

Returns:

the request

Throws:

IOException

list

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

Lists all developers in an organization by email address. By default, the response does not include company developers. Set the `includeCompany` query parameter to `true` to include company developers. **Note**: A maximum of 1000 developers are returned in the response. You paginate the list of developers returned using the `startKey` and `count` query parameters. Create a request for the method "developers.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

setDeveloperStatus

public Apigee.Organizations.Developers.SetDeveloperStatus setDeveloperStatus(String name)
                                                                      throws IOException

Sets the status of a developer. A developer is `active` by default. If you set a developer's status to `inactive`, the API keys assigned to the developer apps are no longer valid even though the API keys are set to `approved`. Inactive developers can still sign in to the developer portal and create apps; however, any new API keys generated during app creation won't work. To set the status of a developer, set the `action` query parameter to `active` or `inactive`, and the `Content-Type` header to `application/octet-stream`. If successful, the API call returns the following HTTP status code: `204 No Content` Create a request for the method "developers.setDeveloperStatus". 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. Use the following structure in your request: `organizations/{org}/developers/{developer_id}`

Returns:

the request

Throws:

IOException

update

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

Updates a developer. This API replaces the existing developer details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. The custom attribute limit is 18. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. Create a request for the method "developers.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. Email address of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}`

content - the GoogleCloudApigeeV1Developer

Returns:

the request

Throws:

IOException

updateMonetizationConfig

public Apigee.Organizations.Developers.UpdateMonetizationConfig updateMonetizationConfig(String name,
                                                                                         GoogleCloudApigeeV1DeveloperMonetizationConfig content)
                                                                                  throws IOException

Updates the monetization configuration for the developer. Create a request for the method "developers.updateMonetizationConfig". 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. Monetization configuration for the developer. Use the following structure in your request: `organizations/{org}/developers/{developer}/monetizationConfig`

content - the GoogleCloudApigeeV1DeveloperMonetizationConfig

Returns:

the request

Throws:

IOException

apps

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

attributes

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

balance

public Apigee.Organizations.Developers.Balance balance()

An accessor for creating requests from the Balance collection.

The typical use is:

    Apigee apigee = new Apigee(...);
    Apigee.Balance.List request = apigee.balance().list(parameters ...)
 

Returns:

the resource collection

subscriptions

public Apigee.Organizations.Developers.Subscriptions subscriptions()

An accessor for creating requests from the Subscriptions collection.

The typical use is:

    Apigee apigee = new Apigee(...);
    Apigee.Subscriptions.List request = apigee.subscriptions().list(parameters ...)
 

Returns:

the resource collection