📄 Source: OrganizationsAppgroups.php
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Apigee\Resource;
use Google\Service\Apigee\GoogleCloudApigeeV1AppGroup;
use Google\Service\Apigee\GoogleCloudApigeeV1AppGroupBalance;
use Google\Service\Apigee\GoogleCloudApigeeV1AppGroupMonetizationConfig;
use Google\Service\Apigee\GoogleCloudApigeeV1ListAppGroupsResponse;
/**
* The "appgroups" collection of methods.
* Typical usage is:
* <code>
* $apigeeService = new Google\Service\Apigee(...);
* $appgroups = $apigeeService->organizations_appgroups;
* </code>
*/
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 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);
}
/**
* Gets the account balance for the AppGroup. (appgroups.getBalance)
*
* @param string $name Required. Account balance for the AppGroup. Use the
* following structure in your request:
* `organizations/{org}/appgroups/{app_group}/balance`
* @param array $optParams Optional parameters.
* @return GoogleCloudApigeeV1AppGroupBalance
* @throws \Google\Service\Exception
*/
public function getBalance($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getBalance', [$params], GoogleCloudApigeeV1AppGroupBalance::class);
}
/**
* Gets the monetization configuration for the AppGroup.
* (appgroups.getMonetizationConfig)
*
* @param string $name Required. Monetization configuration for the AppGroup.
* Use the following structure in your request:
* `organizations/{org}/appgroups/{app_group}/monetizationConfig`
* @param array $optParams Optional parameters.
* @return GoogleCloudApigeeV1AppGroupMonetizationConfig
* @throws \Google\Service\Exception
*/
public function getMonetizationConfig($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getMonetizationConfig', [$params], GoogleCloudApigeeV1AppGroupMonetizationConfig::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);
}
/**
* Updates the monetization configuration for the AppGroup.
* (appgroups.updateMonetizationConfig)
*
* @param string $name Required. Monetization configuration for the AppGroup.
* Use the following structure in your request:
* `organizations/{org}/appgroups/{app_group}/monetizationConfig`
* @param GoogleCloudApigeeV1AppGroupMonetizationConfig $postBody
* @param array $optParams Optional parameters.
* @return GoogleCloudApigeeV1AppGroupMonetizationConfig
* @throws \Google\Service\Exception
*/
public function updateMonetizationConfig($name, GoogleCloudApigeeV1AppGroupMonetizationConfig $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('updateMonetizationConfig', [$params], GoogleCloudApigeeV1AppGroupMonetizationConfig::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(OrganizationsAppgroups::class, 'Google_Service_Apigee_Resource_OrganizationsAppgroups');
← Back