Documentation

Google_Service_Apigee_Resource_OrganizationsApiproducts extends Google_Service_Resource
in package

Application

The "apiproducts" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
attributes() : Google_Service_Apigee_GoogleCloudApigeeV1Attributes: Updates or creates API product attributes. This API **replaces** the current list of attributes with the attributes specified in the request body. In this way, you can update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. (apiproducts.attributes)
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_Apigee_GoogleCloudApigeeV1ApiProduct: Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on-the- fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer grained API products, defining different sets of API resources for each API product.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Apigee_GoogleCloudApigeeV1ApiProduct: Deletes an API product from an organization. Deleting an API product causes app requests to the resource URIs defined in the API product to fail. Ensure that you create a new API product to serve existing apps, unless your intention is to disable access to the resources defined in the API product.
get() : Google_Service_Apigee_GoogleCloudApigeeV1ApiProduct: Gets configuration details for an API product. The API product name required in the request URL is the internal name of the product, not the display name.
listOrganizationsApiproducts() : Google_Service_Apigee_GoogleCloudApigeeV1ListApiProductsResponse: Lists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The limit on the number of API products returned by the API is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters.
update() : Google_Service_Apigee_GoogleCloudApigeeV1ApiProduct: Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the Display Name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names.
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 —

attributes()

Updates or creates API product attributes. This API **replaces** the current list of attributes with the attributes specified in the request body. In this way, you can update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. (apiproducts.attributes)


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

Parameters

$name : string: Required. API product name in the following form: organizations/organization_ID/apiproducts/api_product_name
$postBody : Google_Service_Apigee_GoogleCloudApigeeV1Attributes
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1Attributes —

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 an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on-the- fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer grained API products, defining different sets of API resources for each API product.


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

WARNING: - If you don't specify an API proxy in the request body, any app associated with the product can make calls to any API in your entire organization. - If you don't specify an environment in the request body, the product allows access to all environments. For more information, see {{what_api_product}} (apiproducts.create)

Parameters

$parent : string: Required. The parent organization name under which the API product will be created. Must be in the following form: organizations/organization_ID
$postBody : Google_Service_Apigee_GoogleCloudApigeeV1ApiProduct
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1ApiProduct —

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 API product from an organization. Deleting an API product causes app requests to the resource URIs defined in the API product to fail. Ensure that you create a new API product to serve existing apps, unless your intention is to disable access to the resources defined in the API product.


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

The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name. (apiproducts.delete)

Parameters

$name : string: Required. API product name in the following form: organizations/organization_ID/apiproducts/api_product_name
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1ApiProduct —

get()

Gets configuration details for an API product. The API product name required in the request URL is the internal name of the product, not the display name.


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

While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name. (apiproducts.get)

Parameters

$name : string: Required. API product name in the following form: organizations/organization_ID/apiproducts/api_product_name
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1ApiProduct —

listOrganizationsApiproducts()

Lists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The limit on the number of API products returned by the API is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters.


    public
                listOrganizationsApiproducts(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1ListApiProductsResponse

(apiproducts.listOrganizationsApiproducts)

Parameters

$parent : string: Required. The parent organization name in the following form: organizations/organization_ID
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1ListApiProductsResponse —

update()

Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the Display Name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names.


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

(apiproducts.update)

Parameters

$name : string: Required. API product name in the following form: organizations/organization_ID/apiproducts/api_product_name
$postBody : Google_Service_Apigee_GoogleCloudApigeeV1ApiProduct
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1ApiProduct —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —