Class Index | File Index

Classes


Class Metric


Defined in: rhqapi.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Metric()
creates a new instance of Metric
Field Summary
Field Attributes Field Name and Description
 
data type of metric
Method Summary
Method Attributes Method Name and Description
 
gets actual metric collection interval
 
gets live value for metric
 
returns true if this metrics is enabled, false otherwise
 
set(enabled, interval)
enables/disables metric and sets its collection interval
Class Detail
Metric()
creates a new instance of Metric
Field Detail
{String} dataType
data type of metric
Method Detail
{Number} getInterval()
gets actual metric collection interval
Returns:
Number interval in milis

{String} getLiveValue()
gets live value for metric
Returns:
String whatever the value is

{Boolean} isEnabled()
returns true if this metrics is enabled, false otherwise
Returns:
Boolean true if this metrics is enabled, false otherwise

set(enabled, interval)
enables/disables metric and sets its collection interval
Parameters:
enabled
{Boolean} - enable or disable metric
interval
{Number} - optinally set collection interval (seconds)

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Jan 06 2014 16:48:32 GMT+0100 (CET)