class OrganizationsReports extends Resource (View source)

The "reports" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $reports = $apigeeService->organizations_reports;

Methods

create(string $parent, GoogleCloudApigeeV1CustomReport $postBody, array $optParams = [])

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)

delete(string $name, array $optParams = [])

Deletes an existing custom report definition (reports.delete)

get(string $name, array $optParams = [])

Retrieve a custom report definition. (reports.get)

listOrganizationsReports(string $parent, array $optParams = [])

Return a list of Custom Reports (reports.listOrganizationsReports)

update(string $name, GoogleCloudApigeeV1CustomReport $postBody, array $optParams = [])

Update an existing custom report definition (reports.update)

Details

GoogleCloudApigeeV1CustomReport create(string $parent, GoogleCloudApigeeV1CustomReport $postBody, array $optParams = [])

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)

Parameters

string $parent

Required. The parent organization name under which the Custom Report will be created. Must be of the form: organizations/{organization_id}/reports

GoogleCloudApigeeV1CustomReport $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1CustomReport

Exceptions

Exception

GoogleCloudApigeeV1DeleteCustomReportResponse delete(string $name, array $optParams = [])

Deletes an existing custom report definition (reports.delete)

Parameters

string $name

Required. Custom Report name of the form: organizations/{organization_id}/reports/{report_name}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1DeleteCustomReportResponse

Exceptions

Exception

GoogleCloudApigeeV1CustomReport get(string $name, array $optParams = [])

Retrieve a custom report definition. (reports.get)

Parameters

string $name

Required. Custom Report name of the form: organizations/{organization_id}/reports/{report_name}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1CustomReport

Exceptions

Exception

GoogleCloudApigeeV1ListCustomReportsResponse listOrganizationsReports(string $parent, array $optParams = [])

Return a list of Custom Reports (reports.listOrganizationsReports)

Parameters

string $parent

Required. The parent organization name under which the API product will be listed organizations/{organization_id}/reports

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ListCustomReportsResponse

Exceptions

Exception

GoogleCloudApigeeV1CustomReport update(string $name, GoogleCloudApigeeV1CustomReport $postBody, array $optParams = [])

Update an existing custom report definition (reports.update)

Parameters

string $name

Required. Custom Report name of the form: organizations/{organization_id}/reports/{report_name}

GoogleCloudApigeeV1CustomReport $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1CustomReport

Exceptions

Exception