com.google.api.services.apigee.v1

Class Apigee.Organizations.Apiproducts

java.lang.Object

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

Enclosing class:

Apigee.Organizations

public class Apigee.Organizations.Apiproducts
extends Object

The "apiproducts" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Apiproducts.Attributes The "attributes" collection of methods.
class	Apigee.Organizations.Apiproducts.AttributesRequest
class	Apigee.Organizations.Apiproducts.Create
class	Apigee.Organizations.Apiproducts.Delete
class	Apigee.Organizations.Apiproducts.Get
class	Apigee.Organizations.Apiproducts.List
class	Apigee.Organizations.Apiproducts.Move
class	Apigee.Organizations.Apiproducts.Rateplans The "rateplans" collection of methods.
class	Apigee.Organizations.Apiproducts.Update

Constructor Summary

Constructors

Constructor and Description
Apiproducts()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Apiproducts.Attributes	attributes() An accessor for creating requests from the Attributes collection.
Apigee.Organizations.Apiproducts.AttributesRequest	attributes(String name, GoogleCloudApigeeV1Attributes content) Updates or creates API product attributes.
Apigee.Organizations.Apiproducts.Create	create(String parent, GoogleCloudApigeeV1ApiProduct content) Creates an API product in an organization.
Apigee.Organizations.Apiproducts.Delete	delete(String name) Deletes an API product from an organization.
Apigee.Organizations.Apiproducts.Get	get(String name) Gets configuration details for an API product.
Apigee.Organizations.Apiproducts.List	list(String parent) Lists all API product names for an organization.
Apigee.Organizations.Apiproducts.Move	move(String name, GoogleCloudApigeeV1MoveApiProductRequest content) Moves an API product to a different space.
Apigee.Organizations.Apiproducts.Rateplans	rateplans() An accessor for creating requests from the Rateplans collection.
Apigee.Organizations.Apiproducts.Update	update(String name, GoogleCloudApigeeV1ApiProduct content) Updates an existing API product.

Methods inherited from class java.lang.Object

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

Constructor Detail

Apiproducts

public Apiproducts()

Method Detail

attributes

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

Updates or creates API product attributes. This API **replaces** the current list of attributes with the attributes specified in the request body. In this way, you can update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. **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 entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `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 "apiproducts.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 API product. 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 GoogleCloudApigeeV1Attributes

Returns:

the request

Throws:

IOException

create

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

Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on the fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer-grained API products, defining different sets of API resources for each API product. **WARNING:** - If you don't specify an API proxy in the request body, *any* app associated with the product can make calls to *any* API in your entire organization. - If you don't specify an environment in the request body, the product allows access to all environments. For more information, see What is an API product? Create a request for the method "apiproducts.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 organization in which the API product will be created. Use the following structure in your request: `organizations/{org}` If the 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 GoogleCloudApigeeV1ApiProduct

Returns:

the request

Throws:

IOException

delete

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

Deletes an API product from an organization. Deleting an API product causes app requests to the resource URIs defined in the API product to fail. Ensure that you create a new API product to serve existing apps, unless your intention is to disable access to the resources defined in the API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name. Create a request for the method "apiproducts.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 API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the 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.Get get(String name)
                                         throws IOException

Gets configuration details for an API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name. Create a request for the method "apiproducts.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 API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the 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.List list(String parent)
                                           throws IOException

Lists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview). Create a request for the method "apiproducts.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 organization. Use the following structure in your request: `organizations/{org}` If the 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

move

public Apigee.Organizations.Apiproducts.Move move(String name,
                                                  GoogleCloudApigeeV1MoveApiProductRequest content)
                                           throws IOException

Moves an API product to a different space. Create a request for the method "apiproducts.move". 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. API product to move in the following format: `organizations/{org}/apiproducts/{apiproduct}

content - the GoogleCloudApigeeV1MoveApiProductRequest

Returns:

the request

Throws:

IOException

update

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

Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names. Create a request for the method "apiproducts.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 API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the 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 GoogleCloudApigeeV1ApiProduct

Returns:

the request

Throws:

IOException

attributes

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

rateplans

public Apigee.Organizations.Apiproducts.Rateplans rateplans()

An accessor for creating requests from the Rateplans collection.

The typical use is:

    Apigee apigee = new Apigee(...);
    Apigee.Rateplans.List request = apigee.rateplans().list(parameters ...)
 

Returns:

the resource collection