com.google.api.services.apigee.v1

Class Apigee.Organizations.Reports

java.lang.Object

com.google.api.services.apigee.v1.Apigee.Organizations.Reports

Enclosing class:

Apigee.Organizations

public class Apigee.Organizations.Reports
extends Object

The "reports" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Reports.Create
class	Apigee.Organizations.Reports.Delete
class	Apigee.Organizations.Reports.Get
class	Apigee.Organizations.Reports.List
class	Apigee.Organizations.Reports.Update

Constructor Summary

Constructors

Constructor and Description
Reports()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Reports.Create	create(String parent, GoogleCloudApigeeV1CustomReport content) Creates a Custom Report for an Organization.
Apigee.Organizations.Reports.Delete	delete(String name) Deletes an existing custom report definition Create a request for the method "reports.delete".
Apigee.Organizations.Reports.Get	get(String name) Retrieve a custom report definition.
Apigee.Organizations.Reports.List	list(String parent) Return a list of Custom Reports Create a request for the method "reports.list".
Apigee.Organizations.Reports.Update	update(String name, GoogleCloudApigeeV1CustomReport content) Update an existing custom report definition Create a request for the method "reports.update".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Reports

public Reports()

Method Detail

create

public Apigee.Organizations.Reports.Create create(String parent,
                                                  GoogleCloudApigeeV1CustomReport content)
                                           throws IOException

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. Create a request for the method "reports.create". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the GoogleCloudApigeeV1CustomReport

Returns:

the request

Throws:

IOException

delete

public Apigee.Organizations.Reports.Delete delete(String name)
                                           throws IOException

Deletes an existing custom report definition Create a request for the method "reports.delete". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

get

public Apigee.Organizations.Reports.Get get(String name)
                                     throws IOException

Retrieve a custom report definition. Create a request for the method "reports.get". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

list

public Apigee.Organizations.Reports.List list(String parent)
                                       throws IOException

Return a list of Custom Reports Create a request for the method "reports.list". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

update

public Apigee.Organizations.Reports.Update update(String name,
                                                  GoogleCloudApigeeV1CustomReport content)
                                           throws IOException

Update an existing custom report definition Create a request for the method "reports.update". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the GoogleCloudApigeeV1CustomReport

Returns:

the request

Throws:

IOException