class OrganizationsAppgroups extends Resource (View source)

The "appgroups" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $appgroups = $apigeeService->organizations_appgroups;

Methods

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

Creates an AppGroup. Once created, user can register apps under the AppGroup to obtain secret key and password. At creation time, the AppGroup's state is set as active. (appgroups.create)

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

Deletes an AppGroup. All app and API keys associations with the AppGroup are also removed. Warning: This API will permanently delete the AppGroup and related artifacts. Note: The delete operation is asynchronous. The AppGroup app 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. (appgroups.delete)

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

Returns the AppGroup details for the provided AppGroup name in the request URI. (appgroups.get)

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

Lists all AppGroups in an organization. A maximum of 1000 AppGroups are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000. (appgroups.listOrganizationsAppgroups)

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

Updates an AppGroup. This API replaces the existing AppGroup details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. Note that the state of the AppGroup should be updated using action, and not via AppGroup.

Details

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

Creates an AppGroup. Once created, user can register apps under the AppGroup to obtain secret key and password. At creation time, the AppGroup's state is set as active. (appgroups.create)

Parameters

string $parent

Required. Name of the Apigee organization in which the AppGroup is created. Use the following structure in your request: organizations/{org}.

GoogleCloudApigeeV1AppGroup $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1AppGroup

Exceptions

Exception

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

Deletes an AppGroup. All app and API keys associations with the AppGroup are also removed. Warning: This API will permanently delete the AppGroup and related artifacts. Note: The delete operation is asynchronous. The AppGroup app 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. (appgroups.delete)

Parameters

string $name

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

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1AppGroup

Exceptions

Exception

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

Returns the AppGroup details for the provided AppGroup name in the request URI. (appgroups.get)

Parameters

string $name

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

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1AppGroup

Exceptions

Exception

GoogleCloudApigeeV1ListAppGroupsResponse listOrganizationsAppgroups(string $parent, array $optParams = [])

Lists all AppGroups in an organization. A maximum of 1000 AppGroups are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000. (appgroups.listOrganizationsAppgroups)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ListAppGroupsResponse

Exceptions

Exception

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

Updates an AppGroup. This API replaces the existing AppGroup details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. Note that the state of the AppGroup should be updated using action, and not via AppGroup.

(appgroups.update)

Parameters

string $name

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

GoogleCloudApigeeV1AppGroup $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1AppGroup

Exceptions

Exception