Documentation

Google_Service_Apigee_Resource_OrganizationsApps extends Google_Service_Resource
in package

The "apps" collection of methods.

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

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.
get()  : Google_Service_Apigee_GoogleCloudApigeeV1App
Gets the app profile for the specified app ID. (apps.get)
listOrganizationsApps()  : Google_Service_Apigee_GoogleCloudApigeeV1ListAppsResponse
Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company). (apps.listOrganizationsApps)
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

listOrganizationsApps()

Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company). (apps.listOrganizationsApps)

public listOrganizationsApps(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1ListAppsResponse
Parameters
$parent : string

Required. Resource path of the parent in the following format: organizations/{org}

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

Optional parameters.

Tags
opt_param

string ids Optional. Comma-separated list of app IDs on which to filter.

opt_param

string rows Optional. Maximum number of app IDs to return. Defaults to 10000.

opt_param

string keyStatus Optional. Key status of the app. Valid values include approved or revoked. Defaults to approved.

opt_param

bool includeCred Optional. Flag that specifies whether to include credentials in the response.

opt_param

string startKey Returns the list of apps starting from the specified app ID.

opt_param

string apptype Optional. Filter by the type of the app. Valid values are company or developer. Defaults to developer.

opt_param

string apiProduct API product.

opt_param

bool expand Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults to false.

opt_param

string status Optional. Filter by the status of the app. Valid values are approved or revoked. Defaults to approved.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1ListAppsResponse

convertToArrayAndStripNulls()

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

Search results