Package org.elasticsearch.timeseries.support

Class TimeSeriesMetrics

java.lang.Object

org.elasticsearch.timeseries.support.TimeSeriesMetrics

public class TimeSeriesMetrics
extends Object

Reads data in a time series style way.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimeSeriesMetrics.TimeSeriesDimensionSelector
static class	TimeSeriesMetrics.TimeSeriesMetricSelector
static enum	TimeSeriesMetrics.TimeSeriesSelectorMatcher

Method Summary

Modifier and Type	Method	Description
void	latest(List<TimeSeriesMetrics.TimeSeriesMetricSelector> metrics, List<TimeSeriesMetrics.TimeSeriesDimensionSelector> dimensions, long time, org.elasticsearch.timeseries.support.TimeSeriesMetrics.MetricsCallback callback)	Return the latest metrics before time within staleness period.
void	range(List<TimeSeriesMetrics.TimeSeriesMetricSelector> metrics, List<TimeSeriesMetrics.TimeSeriesDimensionSelector> dimensions, long time, org.elasticsearch.core.TimeValue range, org.elasticsearch.core.TimeValue step, org.elasticsearch.timeseries.support.TimeSeriesMetrics.MetricsCallback callback)	Return all metrics with range time period just before and including the time specified by the time parameter
void	range(List<TimeSeriesMetrics.TimeSeriesMetricSelector> metrics, List<TimeSeriesMetrics.TimeSeriesDimensionSelector> dimensions, long time, org.elasticsearch.core.TimeValue range, org.elasticsearch.timeseries.support.TimeSeriesMetrics.MetricsCallback callback)	Return all metrics with range time period just before and including the time specified by the time parameter

Methods inherited from class java.lang.Object

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

Method Details

latest

public void latest(List<TimeSeriesMetrics.TimeSeriesMetricSelector> metrics,
 List<TimeSeriesMetrics.TimeSeriesDimensionSelector> dimensions,
 long time,
 org.elasticsearch.timeseries.support.TimeSeriesMetrics.MetricsCallback callback)

Return the latest metrics before time within staleness period.

Parameters:

metrics - metrics selectors (ANDed together)

dimensions - dimension selectors (ANDed together)

time - the time before which the latest metrics are returned

callback - callback used to return the metrics

range

public void range(List<TimeSeriesMetrics.TimeSeriesMetricSelector> metrics,
 List<TimeSeriesMetrics.TimeSeriesDimensionSelector> dimensions,
 long time,
 org.elasticsearch.core.TimeValue range,
 org.elasticsearch.timeseries.support.TimeSeriesMetrics.MetricsCallback callback)

Return all metrics with range time period just before and including the time specified by the time parameter

Parameters:

metrics - metrics selectors (ANDed together)

dimensions - dimension selectors (ANDed together)

time - the time before which the results are returned

range - range within which the results are returned

callback - callback used to return the metrics

range

public void range(List<TimeSeriesMetrics.TimeSeriesMetricSelector> metrics,
 List<TimeSeriesMetrics.TimeSeriesDimensionSelector> dimensions,
 long time,
 org.elasticsearch.core.TimeValue range,
 org.elasticsearch.core.TimeValue step,
 org.elasticsearch.timeseries.support.TimeSeriesMetrics.MetricsCallback callback)

Return all metrics with range time period just before and including the time specified by the time parameter

Parameters:

metrics - metrics selectors (ANDed together)

dimensions - dimension selectors (ANDed together)

time - the time before which the results are returned

range - range within which the results are returned

step - if not null, it makes this method equivalent to running the latest(List, List, long, MetricsCallback) method several times while changing time from time to (time - range) with the step interval

callback - callback used to return the metrics