AggregatedReportInterface Class Reference

Inherits from DefaultConfiguration : NSObject
Declared in AggregatedReportInterface.h

Overview

AggregatedReportInterface allows querying aggregated metrics data in a single account.

– init

- (id)init

– initAggregatedReportInterfaceWithDefaults

Creates custom instance of the class AggregatedReportInterface

- (id)initAggregatedReportInterfaceWithDefaults

Return Value

instance of the class AggregatedReportInterface

Declared In

AggregatedReportInterface.h

– setStartTimestamp:

Set the start time for query data in be included in the report.

- (void)setStartTimestamp:(long)startTimestamp

Parameters

startTimestamp

time in milliseconds since epoch time.

Declared In

AggregatedReportInterface.h

– setEndTimestamp:

Set the end time for query data in be included in the report.

- (void)setEndTimestamp:(long)endTimestamp

Parameters

endTimestamp

time in milliseconds since epoch time.

Declared In

AggregatedReportInterface.h

– addAggregationMethod:

Add the aggregation method to the query request.

- (void)addAggregationMethod:(NSString *)aggregation

Parameters

aggregation

The aggregation method from the list of acceptable values of “min”, “max”, “average”, “std”, “count” and “sum”. The default is “average”.

Declared In

AggregatedReportInterface.h

– addDimension:

Add a dimension to a list of dimensions for measurements aggregation of the report.

- (void)addDimension:(NSString *)dimension

Parameters

dimension

A dimension of either “timeHour”, “componentName” or “deviceAttribute_any”.

Declared In

AggregatedReportInterface.h

– setOffset:

The first row of the data to return in the report. If this is set the limit must be set also.

- (void)setOffset:(NSInteger)offset

Parameters

offset

The offset into the row of data to retrieve the report.

Declared In

AggregatedReportInterface.h

– setLimit:

The maximum number of rows to include in the report.

- (void)setLimit:(NSInteger)limit

Parameters

limit

the limit for the number of records return.

Declared In

AggregatedReportInterface.h

– setCountOnly:

Setting to true will return the number of rows that would have returned from this report.

- (void)setCountOnly:(BOOL)countOnly

Parameters

countOnly

true will return number of rows

Declared In

AggregatedReportInterface.h

– setOutputType:

Set the output type of the report to be returned.

- (void)setOutputType:(NSString *)outputType

Parameters

outputType

The desired output type of the data. The available options are “csv” or “json”. The default is “json”.

Declared In

AggregatedReportInterface.h

– addDeviceId:

Add a device id that is requested for the data in the report.

- (void)addDeviceId:(NSString *)deviceId

Parameters

deviceId

The device identifier for device data to be included in the report.

Declared In

AggregatedReportInterface.h

– addGatewayId:

Add a gateway id that is requested for the data in the report.

- (void)addGatewayId:(NSString *)gatewayId

Parameters

gatewayId

The gateway identifier for gateway data to be included in the report.

Declared In

AggregatedReportInterface.h

– addComponentId:

Add a component id that is requested for the data in the report.

- (void)addComponentId:(NSString *)componentId

Parameters

componentId

The component identifier for component data to be included in the report.

Declared In

AggregatedReportInterface.h

– addSortInfo:AndValue:

Add the sort criteria to the query.

- (void)addSortInfo:(NSString *)name AndValue:(NSString *)value

Parameters

name

The sort field name.
value

The source value. It must be “Asc” or “Desc”.

Declared In

AggregatedReportInterface.h

– addFilter:

Add attribute filter.

- (void)addFilter:(AttributeFilter *)attributeFilter

Parameters

attributeFilter

the filter to be added.

Declared In

AggregatedReportInterface.h

– request

Starts a request for the report.

- (CloudResponse *)request

Return Value

For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.

Declared In

AggregatedReportInterface.h