Documentation

Google_Service_Apigee_Resource_OrganizationsReports extends Google_Service_Resource
in package

Application

The "reports" collection of methods.

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

$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_GoogleCloudApigeeV1CustomReport: Creates a Custom Report for an Organization. A Custom Report provides Apigee Customers to create custom dashboards in addition to the standard dashboards which are provided. The Custom Report in its simplest form contains specifications about metrics, dimensions and filters. It is important to note that the custom report by itself does not provide an executable entity. The Edge UI converts the custom report definition into an analytics query and displays the result in a chart. (reports.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Apigee_GoogleCloudApigeeV1DeleteCustomReportResponse: Deletes an existing custom report definition (reports.delete)
get() : Google_Service_Apigee_GoogleCloudApigeeV1CustomReport: Retrieve a custom report definition. (reports.get)
listOrganizationsReports() : Google_Service_Apigee_GoogleCloudApigeeV1ListCustomReportsResponse: Return a list of Custom Reports (reports.listOrganizationsReports)
update() : Google_Service_Apigee_GoogleCloudApigeeV1CustomReport: Update an existing custom report definition (reports.update)
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 Report for an Organization. A Custom Report provides Apigee Customers to create custom dashboards in addition to the standard dashboards which are provided. The Custom Report in its simplest form contains specifications about metrics, dimensions and filters. It is important to note that the custom report by itself does not provide an executable entity. The Edge UI converts the custom report definition into an analytics query and displays the result in a chart. (reports.create)


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

Parameters

$parent : string: Required. The parent organization name under which the Custom Report will be created. Must be of the form: organizations/{organization_id}/reports
$postBody : Google_Service_Apigee_GoogleCloudApigeeV1CustomReport
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1CustomReport —

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 existing custom report definition (reports.delete)


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

Parameters

$name : string: Required. Custom Report name of the form: organizations/{organization_id}/reports/{report_name}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1DeleteCustomReportResponse —

get()

Retrieve a custom report definition. (reports.get)


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

Parameters

$name : string: Required. Custom Report name of the form: organizations/{organization_id}/reports/{report_name}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1CustomReport —

listOrganizationsReports()

Return a list of Custom Reports (reports.listOrganizationsReports)


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

Parameters

$parent : string: Required. The parent organization name under which the API product will be listed organizations/{organization_id}/reports
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1ListCustomReportsResponse —

update()

Update an existing custom report definition (reports.update)


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

Parameters

$name : string: Required. Custom Report name of the form: organizations/{organization_id}/reports/{report_name}
$postBody : Google_Service_Apigee_GoogleCloudApigeeV1CustomReport
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Apigee_GoogleCloudApigeeV1CustomReport —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —