Documentation

Google_Service_Apigee_Resource_OrganizationsDevelopersAppsKeysApiproducts extends Google_Service_Resource
in package

The "apiproducts" collection of methods.

Typical usage is: $apigeeService = new Google_Service_Apigee(...); $apiproducts = $apigeeService->apiproducts;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey
Removes an API product from an app's consumer key. After the API product is removed, the app cannot access the API resources defined in that API product.
updateDeveloperAppKeyApiProduct()  : Google_Service_Apigee_GoogleProtobufEmpty
Approve or revoke an app's consumer key. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee hybrid checks the status of the consumer key and if set to `revoked` will not allow access to the API.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Removes an API product from an app's consumer key. After the API product is removed, the app cannot access the API resources defined in that API product.

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey

Note: The consumer key is not removed, only its association with the API product. (apiproducts.delete)

Parameters
$name : string

Name of the API product in the developer app key in the following format: organizations/{org}/developers/{developer_email}/apps/{app }/keys/{key}/apiproducts/{apiproduct}

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey —

updateDeveloperAppKeyApiProduct()

Approve or revoke an app's consumer key. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee hybrid checks the status of the consumer key and if set to `revoked` will not allow access to the API.

public updateDeveloperAppKeyApiProduct(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleProtobufEmpty

(apiproducts.updateDeveloperAppKeyApiProduct)

Parameters
$name : string

Name of the API product in the developer app key in the following format: organizations/{org}/developers/{developer_email}/apps/{app }/keys/{key}/apiproducts/{apiproduct}

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string action Approve or revoke the consumer key by setting this value to approve or revoke, respectively.

Return values
Google_Service_Apigee_GoogleProtobufEmpty —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results