Package com.kaltura.client.services

Class ReportService

java.lang.Object

com.kaltura.client.services.ReportService

public class ReportService
extends Object

api for getting reports data by the report type and some inputFilter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReportService.ExecuteReportBuilder
static class	ReportService.ExportToCsvReportBuilder
static class	ReportService.GetBaseTotalReportBuilder
static class	ReportService.GetCsvFromStringParamsReportBuilder
static class	ReportService.GetCsvReportBuilder
static class	ReportService.GetGraphsReportBuilder
static class	ReportService.GetTableReportBuilder
static class	ReportService.GetTotalReportBuilder
static class	ReportService.GetUrlForReportAsCsvReportBuilder
static class	ReportService.ServeReportBuilder

Constructor Summary

Constructors

Constructor	Description
ReportService()

Method Summary

Modifier and Type	Method	Description
static ReportService.ExecuteReportBuilder	execute(long id)
static ReportService.ExecuteReportBuilder	execute(long id, List<KeyValue> params)
static ReportService.ExportToCsvReportBuilder	exportToCsv(ReportExportParams params)
static ReportService.GetBaseTotalReportBuilder	getBaseTotal(ReportType reportType, ReportInputFilter reportInputFilter)
static ReportService.GetBaseTotalReportBuilder	getBaseTotal(ReportType reportType, ReportInputFilter reportInputFilter, String objectIds)
static ReportService.GetBaseTotalReportBuilder	getBaseTotal(ReportType reportType, ReportInputFilter reportInputFilter, String objectIds, ReportResponseOptions responseOptions)	report getBaseTotal action allows to get the total base for storage reports
static ReportService.GetCsvReportBuilder	getCsv(long id)
static ReportService.GetCsvReportBuilder	getCsv(long id, List<KeyValue> params)
static ReportService.GetCsvReportBuilder	getCsv(long id, List<KeyValue> params, String excludedFields)
static ReportService.GetCsvFromStringParamsReportBuilder	getCsvFromStringParams(long id)
static ReportService.GetCsvFromStringParamsReportBuilder	getCsvFromStringParams(long id, String params)
static ReportService.GetCsvFromStringParamsReportBuilder	getCsvFromStringParams(long id, String params, String excludedFields)	Returns report CSV file executed by string params with the following convention: param1=value1;param2=value2 excludedFields can be supplied comma separated
static ReportService.GetGraphsReportBuilder	getGraphs(ReportType reportType, ReportInputFilter reportInputFilter)
static ReportService.GetGraphsReportBuilder	getGraphs(ReportType reportType, ReportInputFilter reportInputFilter, String dimension)
static ReportService.GetGraphsReportBuilder	getGraphs(ReportType reportType, ReportInputFilter reportInputFilter, String dimension, String objectIds)
static ReportService.GetGraphsReportBuilder	getGraphs(ReportType reportType, ReportInputFilter reportInputFilter, String dimension, String objectIds, ReportResponseOptions responseOptions)	report getGraphs action allows to get a graph data for a specific report.
static ReportService.GetTableReportBuilder	getTable(ReportType reportType, ReportInputFilter reportInputFilter, FilterPager pager)
static ReportService.GetTableReportBuilder	getTable(ReportType reportType, ReportInputFilter reportInputFilter, FilterPager pager, String order)
static ReportService.GetTableReportBuilder	getTable(ReportType reportType, ReportInputFilter reportInputFilter, FilterPager pager, String order, String objectIds)
static ReportService.GetTableReportBuilder	getTable(ReportType reportType, ReportInputFilter reportInputFilter, FilterPager pager, String order, String objectIds, ReportResponseOptions responseOptions)	report getTable action allows to get a graph data for a specific report.
static ReportService.GetTotalReportBuilder	getTotal(ReportType reportType, ReportInputFilter reportInputFilter)
static ReportService.GetTotalReportBuilder	getTotal(ReportType reportType, ReportInputFilter reportInputFilter, String objectIds)
static ReportService.GetTotalReportBuilder	getTotal(ReportType reportType, ReportInputFilter reportInputFilter, String objectIds, ReportResponseOptions responseOptions)	report getTotal action allows to get a graph data for a specific report.
static ReportService.GetUrlForReportAsCsvReportBuilder	getUrlForReportAsCsv(String reportTitle, String reportText, String headers, ReportType reportType, ReportInputFilter reportInputFilter)
static ReportService.GetUrlForReportAsCsvReportBuilder	getUrlForReportAsCsv(String reportTitle, String reportText, String headers, ReportType reportType, ReportInputFilter reportInputFilter, String dimension)
static ReportService.GetUrlForReportAsCsvReportBuilder	getUrlForReportAsCsv(String reportTitle, String reportText, String headers, ReportType reportType, ReportInputFilter reportInputFilter, String dimension, FilterPager pager)
static ReportService.GetUrlForReportAsCsvReportBuilder	getUrlForReportAsCsv(String reportTitle, String reportText, String headers, ReportType reportType, ReportInputFilter reportInputFilter, String dimension, FilterPager pager, String order)
static ReportService.GetUrlForReportAsCsvReportBuilder	getUrlForReportAsCsv(String reportTitle, String reportText, String headers, ReportType reportType, ReportInputFilter reportInputFilter, String dimension, FilterPager pager, String order, String objectIds)
static ReportService.GetUrlForReportAsCsvReportBuilder	getUrlForReportAsCsv(String reportTitle, String reportText, String headers, ReportType reportType, ReportInputFilter reportInputFilter, String dimension, FilterPager pager, String order, String objectIds, ReportResponseOptions responseOptions)	will create a CSV file for the given report and return the URL to access it
static ReportService.ServeReportBuilder	serve(String id)	Will serve a requested report

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportService

public ReportService()

Method Detail

execute

public static ReportService.ExecuteReportBuilder execute(long id)

execute

public static ReportService.ExecuteReportBuilder execute(long id,
                                                         List<KeyValue> params)

exportToCsv

public static ReportService.ExportToCsvReportBuilder exportToCsv(ReportExportParams params)

getBaseTotal

public static ReportService.GetBaseTotalReportBuilder getBaseTotal(ReportType reportType,
                                                                   ReportInputFilter reportInputFilter)

getBaseTotal

public static ReportService.GetBaseTotalReportBuilder getBaseTotal(ReportType reportType,
                                                                   ReportInputFilter reportInputFilter,
                                                                   String objectIds)

getBaseTotal

public static ReportService.GetBaseTotalReportBuilder getBaseTotal(ReportType reportType,
                                                                   ReportInputFilter reportInputFilter,
                                                                   String objectIds,
                                                                   ReportResponseOptions responseOptions)

report getBaseTotal action allows to get the total base for storage reports

Parameters:

reportType -

reportInputFilter -

objectIds - - one ID or more (separated by ',') of specific objects to query

responseOptions -

getCsv

public static ReportService.GetCsvReportBuilder getCsv(long id)

getCsv

public static ReportService.GetCsvReportBuilder getCsv(long id,
                                                       List<KeyValue> params)

getCsv

public static ReportService.GetCsvReportBuilder getCsv(long id,
                                                       List<KeyValue> params,
                                                       String excludedFields)

getCsvFromStringParams

public static ReportService.GetCsvFromStringParamsReportBuilder getCsvFromStringParams(long id)

getCsvFromStringParams

public static ReportService.GetCsvFromStringParamsReportBuilder getCsvFromStringParams(long id,
                                                                                       String params)

getCsvFromStringParams

public static ReportService.GetCsvFromStringParamsReportBuilder getCsvFromStringParams(long id,
                                                                                       String params,
                                                                                       String excludedFields)

Returns report CSV file executed by string params with the following convention: param1=value1;param2=value2 excludedFields can be supplied comma separated

Parameters:

id -

params_ -

excludedFields -

getGraphs

public static ReportService.GetGraphsReportBuilder getGraphs(ReportType reportType,
                                                             ReportInputFilter reportInputFilter)

getGraphs

public static ReportService.GetGraphsReportBuilder getGraphs(ReportType reportType,
                                                             ReportInputFilter reportInputFilter,
                                                             String dimension)

getGraphs

public static ReportService.GetGraphsReportBuilder getGraphs(ReportType reportType,
                                                             ReportInputFilter reportInputFilter,
                                                             String dimension,
                                                             String objectIds)

getGraphs

public static ReportService.GetGraphsReportBuilder getGraphs(ReportType reportType,
                                                             ReportInputFilter reportInputFilter,
                                                             String dimension,
                                                             String objectIds,
                                                             ReportResponseOptions responseOptions)

report getGraphs action allows to get a graph data for a specific report.

Parameters:

reportType -

reportInputFilter -

dimension -

objectIds - - one ID or more (separated by ',') of specific objects to query

responseOptions -

getTable

public static ReportService.GetTableReportBuilder getTable(ReportType reportType,
                                                           ReportInputFilter reportInputFilter,
                                                           FilterPager pager)

getTable

public static ReportService.GetTableReportBuilder getTable(ReportType reportType,
                                                           ReportInputFilter reportInputFilter,
                                                           FilterPager pager,
                                                           String order)

getTable

public static ReportService.GetTableReportBuilder getTable(ReportType reportType,
                                                           ReportInputFilter reportInputFilter,
                                                           FilterPager pager,
                                                           String order,
                                                           String objectIds)

getTable

public static ReportService.GetTableReportBuilder getTable(ReportType reportType,
                                                           ReportInputFilter reportInputFilter,
                                                           FilterPager pager,
                                                           String order,
                                                           String objectIds,
                                                           ReportResponseOptions responseOptions)

report getTable action allows to get a graph data for a specific report.

Parameters:

reportType -

reportInputFilter -

pager -

order -

objectIds - - one ID or more (separated by ',') of specific objects to query

responseOptions -

getTotal

public static ReportService.GetTotalReportBuilder getTotal(ReportType reportType,
                                                           ReportInputFilter reportInputFilter)

getTotal

public static ReportService.GetTotalReportBuilder getTotal(ReportType reportType,
                                                           ReportInputFilter reportInputFilter,
                                                           String objectIds)

getTotal

public static ReportService.GetTotalReportBuilder getTotal(ReportType reportType,
                                                           ReportInputFilter reportInputFilter,
                                                           String objectIds,
                                                           ReportResponseOptions responseOptions)

report getTotal action allows to get a graph data for a specific report.

Parameters:

reportType -

reportInputFilter -

objectIds - - one ID or more (separated by ',') of specific objects to query

responseOptions -

getUrlForReportAsCsv

public static ReportService.GetUrlForReportAsCsvReportBuilder getUrlForReportAsCsv(String reportTitle,
                                                                                   String reportText,
                                                                                   String headers,
                                                                                   ReportType reportType,
                                                                                   ReportInputFilter reportInputFilter)

getUrlForReportAsCsv

public static ReportService.GetUrlForReportAsCsvReportBuilder getUrlForReportAsCsv(String reportTitle,
                                                                                   String reportText,
                                                                                   String headers,
                                                                                   ReportType reportType,
                                                                                   ReportInputFilter reportInputFilter,
                                                                                   String dimension)

getUrlForReportAsCsv

public static ReportService.GetUrlForReportAsCsvReportBuilder getUrlForReportAsCsv(String reportTitle,
                                                                                   String reportText,
                                                                                   String headers,
                                                                                   ReportType reportType,
                                                                                   ReportInputFilter reportInputFilter,
                                                                                   String dimension,
                                                                                   FilterPager pager)

getUrlForReportAsCsv

public static ReportService.GetUrlForReportAsCsvReportBuilder getUrlForReportAsCsv(String reportTitle,
                                                                                   String reportText,
                                                                                   String headers,
                                                                                   ReportType reportType,
                                                                                   ReportInputFilter reportInputFilter,
                                                                                   String dimension,
                                                                                   FilterPager pager,
                                                                                   String order)

getUrlForReportAsCsv

public static ReportService.GetUrlForReportAsCsvReportBuilder getUrlForReportAsCsv(String reportTitle,
                                                                                   String reportText,
                                                                                   String headers,
                                                                                   ReportType reportType,
                                                                                   ReportInputFilter reportInputFilter,
                                                                                   String dimension,
                                                                                   FilterPager pager,
                                                                                   String order,
                                                                                   String objectIds)

getUrlForReportAsCsv

public static ReportService.GetUrlForReportAsCsvReportBuilder getUrlForReportAsCsv(String reportTitle,
                                                                                   String reportText,
                                                                                   String headers,
                                                                                   ReportType reportType,
                                                                                   ReportInputFilter reportInputFilter,
                                                                                   String dimension,
                                                                                   FilterPager pager,
                                                                                   String order,
                                                                                   String objectIds,
                                                                                   ReportResponseOptions responseOptions)

will create a CSV file for the given report and return the URL to access it

Parameters:

reportTitle - The title of the report to display at top of CSV

reportText - The text of the filter of the report

headers - The headers of the columns - a map between the enumerations on the server side and the their display text

reportType -

reportInputFilter -

dimension -

pager -

order -

objectIds - - one ID or more (separated by ',') of specific objects to query

responseOptions -

serve

public static ReportService.ServeReportBuilder serve(String id)

Will serve a requested report

Parameters:

id - - the requested id