com.google.api.services.apigee.v1

Class Apigee.Organizations.Apiproducts.Rateplans

java.lang.Object

com.google.api.services.apigee.v1.Apigee.Organizations.Apiproducts.Rateplans

Enclosing class:

Apigee.Organizations.Apiproducts

public class Apigee.Organizations.Apiproducts.Rateplans
extends Object

The "rateplans" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Apiproducts.Rateplans.Create
class	Apigee.Organizations.Apiproducts.Rateplans.Delete
class	Apigee.Organizations.Apiproducts.Rateplans.Get
class	Apigee.Organizations.Apiproducts.Rateplans.List
class	Apigee.Organizations.Apiproducts.Rateplans.Update

Constructor Summary

Constructors

Constructor and Description
Rateplans()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Apiproducts.Rateplans.Create	create(String parent, GoogleCloudApigeeV1RatePlan content) Create a rate plan that is associated with an API product in an organization.
Apigee.Organizations.Apiproducts.Rateplans.Delete	delete(String name) Deletes a rate plan.
Apigee.Organizations.Apiproducts.Rateplans.Get	get(String name) Gets the details of a rate plan.
Apigee.Organizations.Apiproducts.Rateplans.List	list(String parent) Lists all the rate plans for an API product.
Apigee.Organizations.Apiproducts.Rateplans.Update	update(String name, GoogleCloudApigeeV1RatePlan content) Updates an existing rate plan.

Methods inherited from class java.lang.Object

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

Constructor Detail

Rateplans

public Rateplans()

Method Detail

create

public Apigee.Organizations.Apiproducts.Rateplans.Create create(String parent,
                                                                GoogleCloudApigeeV1RatePlan content)
                                                         throws IOException

Create a rate plan that is associated with an API product in an organization. Using rate plans, API product owners can monetize their API products by configuring one or more of the following: - Billing frequency - Initial setup fees for using an API product - Payment funding model (postpaid only) - Fixed recurring or consumption-based charges for using an API product - Revenue sharing with developer partners An API product can have multiple rate plans associated with it but *only one* rate plan can be active at any point of time. **Note: From the developer's perspective, they purchase API products not rate plans. Create a request for the method "rateplans.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 API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview).

content - the GoogleCloudApigeeV1RatePlan

Returns:

the request

Throws:

IOException

delete

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

Deletes a rate plan. Create a request for the method "rateplans.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. ID of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview).

Returns:

the request

Throws:

IOException

get

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

Gets the details of a rate plan. Create a request for the method "rateplans.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 rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview).

Returns:

the request

Throws:

IOException

list

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

Lists all the rate plans for an API product. Create a request for the method "rateplans.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 API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` Use `organizations/{org}/apiproducts/-` to return rate plans for all API products within the organization. If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview).

Returns:

the request

Throws:

IOException

update

public Apigee.Organizations.Apiproducts.Rateplans.Update update(String name,
                                                                GoogleCloudApigeeV1RatePlan content)
                                                         throws IOException

Updates an existing rate plan. Create a request for the method "rateplans.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 rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview).

content - the GoogleCloudApigeeV1RatePlan

Returns:

the request

Throws:

IOException