* $apigeeService = new Google\Service\Apigee(...); * $appgroups = $apigeeService->organizations_appgroups; * */ class OrganizationsAppgroups extends \Google\Service\Resource { /** * 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) * * @param string $parent Required. Name of the Apigee organization in which the * AppGroup is created. Use the following structure in your request: * `organizations/{org}`. * @param GoogleCloudApigeeV1AppGroup $postBody * @param array $optParams Optional parameters. * @return GoogleCloudApigeeV1AppGroup * @throws \Google\Service\Exception */ public function create($parent, GoogleCloudApigeeV1AppGroup $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], GoogleCloudApigeeV1AppGroup::class); } /** * 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) * * @param string $name Required. Name of the AppGroup. Use the following * structure in your request: `organizations/{org}/appgroups/{app_group_name}` * @param array $optParams Optional parameters. * @return GoogleCloudApigeeV1AppGroup * @throws \Google\Service\Exception */ public function delete($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], GoogleCloudApigeeV1AppGroup::class); } /** * Returns the AppGroup details for the provided AppGroup name in the request * URI. (appgroups.get) * * @param string $name Required. Name of the AppGroup. Use the following * structure in your request: `organizations/{org}/appgroups/{app_group_name}` * @param array $optParams Optional parameters. * @return GoogleCloudApigeeV1AppGroup * @throws \Google\Service\Exception */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], GoogleCloudApigeeV1AppGroup::class); } /** * 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) * * @param string $parent Required. Name of the Apigee organization. Use the * following structure in your request: `organizations/{org}`. * @param array $optParams Optional parameters. * * @opt_param string filter The filter expression to be used to get the list of * AppGroups, where filtering can be done on status, channelId or channelUri of * the app group. Examples: filter=status=active", filter=channelId=, * filter=channelUri= * @opt_param int pageSize Count of AppGroups a single page can have in the * response. If unspecified, at most 1000 AppGroups will be returned. The * maximum value is 1000; values above 1000 will be coerced to 1000. * @opt_param string pageToken The starting index record for listing the * AppGroups. * @return GoogleCloudApigeeV1ListAppGroupsResponse * @throws \Google\Service\Exception */ public function listOrganizationsAppgroups($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], GoogleCloudApigeeV1ListAppGroupsResponse::class); } /** * 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) * * @param string $name Required. Name of the AppGroup. Use the following * structure in your request: `organizations/{org}/appgroups/{app_group_name}` * @param GoogleCloudApigeeV1AppGroup $postBody * @param array $optParams Optional parameters. * * @opt_param string action Activate or de-activate the AppGroup by setting the * action as `active` or `inactive`. The `Content-Type` header must be set to * `application/octet-stream`, with empty body. * @return GoogleCloudApigeeV1AppGroup * @throws \Google\Service\Exception */ public function update($name, GoogleCloudApigeeV1AppGroup $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('update', [$params], GoogleCloudApigeeV1AppGroup::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(OrganizationsAppgroups::class, 'Google_Service_Apigee_Resource_OrganizationsAppgroups');