class OrganizationsApiproducts extends Resource (View source)

The "apiproducts" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $apiproducts = $apigeeService->organizations_apiproducts;

Methods

attributes(string $name, GoogleCloudApigeeV1Attributes $postBody, array $optParams = [])

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. (apiproducts.attributes)

create(string $parent, GoogleCloudApigeeV1ApiProduct $postBody, array $optParams = [])

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.

delete(string $name, array $optParams = [])

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.

get(string $name, array $optParams = [])

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.

listOrganizationsApiproducts(string $parent, array $optParams = [])

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.

update(string $name, GoogleCloudApigeeV1ApiProduct $postBody, array $optParams = [])

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.

Details

GoogleCloudApigeeV1Attributes attributes(string $name, GoogleCloudApigeeV1Attributes $postBody, array $optParams = [])

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. (apiproducts.attributes)

Parameters

string $name

Required. Name of the API product. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}

GoogleCloudApigeeV1Attributes $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1Attributes

Exceptions

Exception

GoogleCloudApigeeV1ApiProduct create(string $parent, GoogleCloudApigeeV1ApiProduct $postBody, array $optParams = [])

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? (apiproducts.create)

Parameters

string $parent

Required. Name of the organization in which the API product will be created. Use the following structure in your request: organizations/{org}

GoogleCloudApigeeV1ApiProduct $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ApiProduct

Exceptions

Exception

GoogleCloudApigeeV1ApiProduct delete(string $name, array $optParams = [])

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. (apiproducts.delete)

Parameters

string $name

Required. Name of the API product. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ApiProduct

Exceptions

Exception

GoogleCloudApigeeV1ApiProduct get(string $name, array $optParams = [])

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. (apiproducts.get)

Parameters

string $name

Required. Name of the API product. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ApiProduct

Exceptions

Exception

GoogleCloudApigeeV1ListApiProductsResponse listOrganizationsApiproducts(string $parent, array $optParams = [])

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.

(apiproducts.listOrganizationsApiproducts)

Parameters

string $parent

Required. Name of the organization. Use the following structure in your request: organizations/{org}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ListApiProductsResponse

Exceptions

Exception

GoogleCloudApigeeV1ApiProduct update(string $name, GoogleCloudApigeeV1ApiProduct $postBody, array $optParams = [])

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.

(apiproducts.update)

Parameters

string $name

Required. Name of the API product. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}

GoogleCloudApigeeV1ApiProduct $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ApiProduct

Exceptions

Exception