Documentation

Google_Service_Apigee_Resource_OrganizationsDevelopersAppsKeys extends Google_Service_Resource
in package

Application

The "keys" collection of methods.

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

$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.
create() : Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey: Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee hybrid from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API. (keys.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey: Deletes an app's consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs. **Note**: After you delete a consumer key, you may want to: 1. Create a new consumer key and secret for the developer app using the CreateDeveloperAppKey API, and subsequently add an API product to the key using the UpdateDeveloperAppKey API. 2. Delete the developer app, if it is no longer required. (keys.delete)
get() : Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey: Returns details for a consumer key for a developer app, including the key and secret value, associated API products, and other information. (keys.get)
replaceDeveloperAppKey() : Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey: Updates the scope of an app. This API replaces the existing scopes with those specified in the request. Include or exclude any existing scopes that you want to retain or delete, respectively. The specified scopes must already be defined for the API products associated with the app. This API sets the `scopes` element under the `apiProducts` element in the attributes of the app. (keys.replaceDeveloperAppKey)
updateDeveloperAppKey() : Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey: Adds an API product to a developer app key, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes to a developer app key. 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. You can use the same key to access all API products associated with the app.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

Return values

Google_Http_Request|expectedClass —

create()

Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee hybrid from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API. (keys.create)


    public
                create(string $parent, Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey

Parameters

$parent : string: Parent of the developer app key. Use the following structure in your request: organizations/{org}/developers/{developer_email}/apps
$postBody : Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey —

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>

Return values

string —

$requestUrl

delete()

Deletes an app's consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs. **Note**: After you delete a consumer key, you may want to: 1. Create a new consumer key and secret for the developer app using the CreateDeveloperAppKey API, and subsequently add an API product to the key using the UpdateDeveloperAppKey API. 2. Delete the developer app, if it is no longer required. (keys.delete)


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

Parameters

$name : string: Name of the developer app key. Use the following structure in your request: organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey —

get()

Returns details for a consumer key for a developer app, including the key and secret value, associated API products, and other information. (keys.get)


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

Parameters

$name : string: Name of the developer app key. Use the following structure in your request: organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey —

replaceDeveloperAppKey()

Updates the scope of an app. This API replaces the existing scopes with those specified in the request. Include or exclude any existing scopes that you want to retain or delete, respectively. The specified scopes must already be defined for the API products associated with the app. This API sets the `scopes` element under the `apiProducts` element in the attributes of the app. (keys.replaceDeveloperAppKey)


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

Parameters

$name : string: Name of the developer app key. Use the following structure in your request: organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}
$postBody : Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey —

updateDeveloperAppKey()

Adds an API product to a developer app key, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes to a developer app key. 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. You can use the same key to access all API products associated with the app.


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

(keys.updateDeveloperAppKey)

Parameters

$name : string: Name of the developer app key. Use the following structure in your request: organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}
$postBody : Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1DeveloperAppKey —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —