class OrganizationsAppgroupsApps extends Resource (View source)

The "apps" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $apps = $apigeeService->organizations_appgroups_apps;

Methods

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

Creates an app and associates it with an AppGroup. This API associates the AppGroup 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. (apps.create)

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

Deletes an AppGroup app. Note: The delete operation is asynchronous. The AppGroup 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. (apps.delete)

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

Returns the details for an AppGroup app. (apps.get)

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

Lists all apps created by an AppGroup in an Apigee organization. Optionally, you can request an expanded view of the AppGroup apps. Lists all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000.

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

Updates the details for an AppGroup app. In addition, you can add an API product to an AppGroup 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 UpdateAppGroupAppKey API. Using this API, you cannot update the app name, as it is the primary key used to identify the app and cannot be changed. This API replaces the existing attributes with those specified in the request.

Details

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

Creates an app and associates it with an AppGroup. This API associates the AppGroup 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. (apps.create)

Parameters

string $parent

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

GoogleCloudApigeeV1AppGroupApp $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1AppGroupApp

Exceptions

Exception

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

Deletes an AppGroup app. Note: The delete operation is asynchronous. The AppGroup 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. (apps.delete)

Parameters

string $name

Required. Name of the AppGroup app. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}/apps/{app}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1AppGroupApp

Exceptions

Exception

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

Returns the details for an AppGroup app. (apps.get)

Parameters

string $name

Required. Name of the AppGroup app. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}/apps/{app}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1AppGroupApp

Exceptions

Exception

GoogleCloudApigeeV1ListAppGroupAppsResponse listOrganizationsAppgroupsApps(string $parent, array $optParams = [])

Lists all apps created by an AppGroup in an Apigee organization. Optionally, you can request an expanded view of the AppGroup apps. Lists all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000.

(apps.listOrganizationsAppgroupsApps)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ListAppGroupAppsResponse

Exceptions

Exception

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

Updates the details for an AppGroup app. In addition, you can add an API product to an AppGroup 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 UpdateAppGroupAppKey API. Using this API, you cannot update the app name, as it is the primary key used to identify the app and cannot be changed. 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. (apps.update)

Parameters

string $name

Required. Name of the AppGroup app. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}/apps/{app}

GoogleCloudApigeeV1AppGroupApp $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1AppGroupApp

Exceptions

Exception