Class: IControl::System::Statistics::PerformanceStatisticQuery

Inherits:
Base::Struct
  • Object
show all
Defined in:
lib/icontrol/system/statistics.rb,
lib/icontrol/system/statistics.rb

Overview

A struct that describes a query for details of a statistical graph or table. If the user specifies a start_time, end_time, and interval that does not exactly match the corresponding value used within the database, the database will attempt to use to closest time or interval as requested. The actual values used will be returned to the user on output. For querying purposes, the start_time can be specified as: 0: in which case by default, it means 24 hours ago. N: where N represents the number of seconds since Jan 1, 1970. -N: where -N represents the number of seconds before now, for example: -3600 means 3600 seconds ago, or now - 3600 seconds For querying purposes, the end_time can be specified as: 0: in which case by default, it means now. N: where N represents the number of seconds since Jan 1, 1970. -N: where -N represents the number of seconds before now, for example: -3600 means 3600 seconds ago, or now - 3600 seconds

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ Numeric

The suggested ending time to stop retrieving data for the graph/table.

Returns:

  • (Numeric) —

    the current value of end_time



1096
1097
1098
 
# File 'lib/icontrol/system/statistics.rb', line 1096

def end_time
  @end_time
end

#interval ⇒ Numeric

The suggested sampling interval in seconds used in creating the graph/table.

Returns:

  • (Numeric) —

    the current value of interval



1096
1097
1098
 
# File 'lib/icontrol/system/statistics.rb', line 1096

def interval
  @interval
end

#maximum_rows ⇒ Numeric

The maximum number of rows to retrieve from the graph/table.

Returns:

  • (Numeric) —

    the current value of maximum_rows



1096
1097
1098
 
# File 'lib/icontrol/system/statistics.rb', line 1096

def maximum_rows
  @maximum_rows
end

#object_name ⇒ String

The key or name of the statistical graph/table.

Returns:

  • (String) —

    the current value of object_name



1096
1097
1098
 
# File 'lib/icontrol/system/statistics.rb', line 1096

def object_name
  @object_name
end

#start_time ⇒ Numeric

The suggested starting time to start retrieving data for the graph/table.

Returns:

  • (Numeric) —

    the current value of start_time



1096
1097
1098
 
# File 'lib/icontrol/system/statistics.rb', line 1096

def start_time
  @start_time
end