Documentation

Google_Service_Apigee_Resource_OrganizationsApiproductsAttributes extends Google_Service_Resource
in package

The "attributes" collection of methods.

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

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_GoogleCloudApigeeV1Attribute
Deletes an API product attribute. (attributes.delete)
get()  : Google_Service_Apigee_GoogleCloudApigeeV1Attribute
Returns the value of an API product attribute. (attributes.get)
listOrganizationsApiproductsAttributes()  : Google_Service_Apigee_GoogleCloudApigeeV1Attributes
Returns a list of all API product attributes.
updateApiProductAttribute()  : Google_Service_Apigee_GoogleCloudApigeeV1Attribute
Updates the value of an API product attribute. Limitations are: 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. (attributes.updateApiProductAttribute)
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()

Deletes an API product attribute. (attributes.delete)

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

Required. API product name in the following form: org anizations/organization_ID/apiproducts/api_product_name/attributes/attribute_ name

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

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1Attribute —

get()

Returns the value of an API product attribute. (attributes.get)

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

Required. API product name in the following form: org anizations/organization_ID/apiproducts/api_product_name/attributes/attribute_ name

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

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1Attribute —

listOrganizationsApiproductsAttributes()

Returns a list of all API product attributes.

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

(attributes.listOrganizationsApiproductsAttributes)

Parameters
$parent : string

Required. The parent organization name. Must be in the following form: organizations/organization_ID/apiproducts/api_product_name

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

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1Attributes —

updateApiProductAttribute()

Updates the value of an API product attribute. Limitations are: 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. (attributes.updateApiProductAttribute)

public updateApiProductAttribute(string $name, Google_Service_Apigee_GoogleCloudApigeeV1Attribute $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1Attribute
Parameters
$name : string

Required. API product name in the following form: organizations/organization_ID/apiproducts/api_product_name

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

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1Attribute —

convertToArrayAndStripNulls()

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

Search results