Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ace.mws.reports
[Groovy] Class Report

java.lang.Object
  com.ace.mws.reports.Report

class Report

A set of time-based values that share similar context. For example, a report may contain data on CPU or power utilization for all nodes in a cluster.

A report is composed of metadata and a collection of Datapoints. Samples are also associated with reports, but these are consolidated using the consolidationFunction to create Datapoints.

Authors:
bsaville

Field Summary
private String consolidationFunction

The consolidation function is the process used to convert a set of samples into a datapoint.

private Long datapointDuration

Required.

private List datapoints

(Datapoint collection) This is the set of datapoints that have been consolidated for the report or are desired to be included in the report during creation time.

private String description

A description of the report.
private String id

The unique identifier for the report.

private Boolean keepSamples

Controls if samples are retained after consolidation.

private Integer minimumSampleSize

If number of samples is below this number, the datapoint data field is "null".

private String name

Required.

private Long reportSize

Required.

 
Constructor Summary
Report()

 
Method Summary
String getConsolidationFunction()

The consolidation function is the process used to convert a set of samples into a datapoint.

Long getDatapointDuration()

Required.

List getDatapoints()

(Datapoint collection) This is the set of datapoints that have been consolidated for the report or are desired to be included in the report during creation time.

String getDescription()

A description of the report.
String getId()

The unique identifier for the report.

Boolean getKeepSamples()

Controls if samples are retained after consolidation.

Integer getMinimumSampleSize()

If number of samples is below this number, the datapoint data field is "null".

String getName()

Required.

Long getReportSize()

Required.

void setConsolidationFunction(String consolidationFunction)

The consolidation function is the process used to convert a set of samples into a datapoint.

void setDatapointDuration(Long datapointDuration)

Required.

void setDatapoints(List datapoints)

(Datapoint collection) This is the set of datapoints that have been consolidated for the report or are desired to be included in the report during creation time.

void setDescription(String description)

A description of the report.
void setId(String id)

The unique identifier for the report.

void setKeepSamples(Boolean keepSamples)

Controls if samples are retained after consolidation.

void setMinimumSampleSize(Integer minimumSampleSize)

If number of samples is below this number, the datapoint data field is "null".

void setName(String name)

Required.

void setReportSize(Long reportSize)

Required.

String toString()

 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Field Detail

consolidationFunction

private String consolidationFunction
The consolidation function is the process used to convert a set of samples into a datapoint. Currently the only supported function is "average", which is used if none is specified.

datapointDuration

private Long datapointDuration
Required. How long the datapoints are, in seconds.

datapoints

private List datapoints
(Datapoint collection) This is the set of datapoints that have been consolidated for the report or are desired to be included in the report during creation time. In the latter case, these represent historical data created outside of the reporting framework.

Valid during GET single report. Valid during POST report.
See Also:
Datapoint

description

private String description
A description of the report.

id

private String id
The unique identifier for the report. This is automatically assigned and will be ignored if specified duration creation.

keepSamples

private Boolean keepSamples
Controls if samples are retained after consolidation. Defaults to false, which means that after consolidation, samples are discarded.

minimumSampleSize

private Integer minimumSampleSize
If number of samples is below this number, the datapoint data field is "null". Defaults to 1.

name

private String name
Required. A unique name identifying the report. Valid characters are all alphanumeric characters, dashes (-), periods (.), and underscores (_).

reportSize

private Long reportSize
Required. The size of the report in datapoints. After this number of datapoints is reached, the old datapoints will be discarded.

WARNING: On report creation, a Mongo collection will be initialized that is the maximum size of a single entry (currently 16 MB) multiplied by the report size. Be careful in setting a large report size as this will quickly allocate the entire disk if many reports with large report sizes are created.

 
Constructor Detail

Report

Report()

 
Method Detail

getConsolidationFunction

String getConsolidationFunction()
The consolidation function is the process used to convert a set of samples into a datapoint. Currently the only supported function is "average", which is used if none is specified.

getDatapointDuration

Long getDatapointDuration()
Required. How long the datapoints are, in seconds.

getDatapoints

List getDatapoints()
(Datapoint collection) This is the set of datapoints that have been consolidated for the report or are desired to be included in the report during creation time. In the latter case, these represent historical data created outside of the reporting framework.

Valid during GET single report. Valid during POST report.
See Also:
Datapoint

getDescription

String getDescription()
A description of the report.

getId

String getId()
The unique identifier for the report. This is automatically assigned and will be ignored if specified duration creation.

getKeepSamples

Boolean getKeepSamples()
Controls if samples are retained after consolidation. Defaults to false, which means that after consolidation, samples are discarded.

getMinimumSampleSize

Integer getMinimumSampleSize()
If number of samples is below this number, the datapoint data field is "null". Defaults to 1.

getName

String getName()
Required. A unique name identifying the report. Valid characters are all alphanumeric characters, dashes (-), periods (.), and underscores (_).

getReportSize

Long getReportSize()
Required. The size of the report in datapoints. After this number of datapoints is reached, the old datapoints will be discarded.

WARNING: On report creation, a Mongo collection will be initialized that is the maximum size of a single entry (currently 16 MB) multiplied by the report size. Be careful in setting a large report size as this will quickly allocate the entire disk if many reports with large report sizes are created.

setConsolidationFunction

void setConsolidationFunction(String consolidationFunction)
The consolidation function is the process used to convert a set of samples into a datapoint. Currently the only supported function is "average", which is used if none is specified.

setDatapointDuration

void setDatapointDuration(Long datapointDuration)
Required. How long the datapoints are, in seconds.

setDatapoints

void setDatapoints(List datapoints)
(Datapoint collection) This is the set of datapoints that have been consolidated for the report or are desired to be included in the report during creation time. In the latter case, these represent historical data created outside of the reporting framework.

Valid during GET single report. Valid during POST report.
See Also:
Datapoint

setDescription

void setDescription(String description)
A description of the report.

setId

void setId(String id)
The unique identifier for the report. This is automatically assigned and will be ignored if specified duration creation.

setKeepSamples

void setKeepSamples(Boolean keepSamples)
Controls if samples are retained after consolidation. Defaults to false, which means that after consolidation, samples are discarded.

setMinimumSampleSize

void setMinimumSampleSize(Integer minimumSampleSize)
If number of samples is below this number, the datapoint data field is "null". Defaults to 1.

setName

void setName(String name)
Required. A unique name identifying the report. Valid characters are all alphanumeric characters, dashes (-), periods (.), and underscores (_).

setReportSize

void setReportSize(Long reportSize)
Required. The size of the report in datapoints. After this number of datapoints is reached, the old datapoints will be discarded.

WARNING: On report creation, a Mongo collection will be initialized that is the maximum size of a single entry (currently 16 MB) multiplied by the report size. Be careful in setting a large report size as this will quickly allocate the entire disk if many reports with large report sizes are created.

toString

String toString()

 

Groovy Documentation