Package step.core.timeseries

Class TimeSeriesAggregationQuery

java.lang.Object

step.core.timeseries.TimeSeriesAggregationQuery

public class TimeSeriesAggregationQuery
extends Object

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TimeSeriesAggregationQuery(TimeSeriesAggregationPipeline aggregationPipeline)

Method Summary

Modifier and Type	Method	Description
protected List<Long>	drawAxis()
TimeSeriesAggregationQuery	filter(Map<String,String> filters)	Specifies the mandatory list of key-value attributes that the series should match
protected Long	getBucketIndexFrom()
protected Long	getBucketIndexTo()
protected long	getBucketSize()
protected Map<String,String>	getFilters()
protected Set<String>	getGroupDimensions()
protected Function<Long,Long>	getProjectionFunction()
TimeSeriesAggregationQuery	group()	Group all the selected series in one series
TimeSeriesAggregationQuery	groupBy(Set<String> dimensions)
TimeSeriesAggregationQuery	range(long from, long to)	Specifies a time range for the query
TimeSeriesAggregationResponse	run()
TimeSeriesAggregationQuery	split(long targetNumberOfBuckets)	Specifies the desired number of buckets in the result.
TimeSeriesAggregationQuery	window(long resolution)	Defines the desired resolution.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeSeriesAggregationQuery

protected TimeSeriesAggregationQuery(TimeSeriesAggregationPipeline aggregationPipeline)

Method Detail

range

public TimeSeriesAggregationQuery range(long from,
                                        long to)

Specifies a time range for the query

Parameters:

from - the beginning of the time range in ms (Epoch time)

to - the end of the time range (Epoch time)

Returns:

the builder

filter

public TimeSeriesAggregationQuery filter(Map<String,String> filters)

Specifies the mandatory list of key-value attributes that the series should match

Parameters:

filters - the mandatory key-value attributes that the series should match

Returns:

the builder

group

public TimeSeriesAggregationQuery group()

Group all the selected series in one series

Returns:

the builder

groupBy

public TimeSeriesAggregationQuery groupBy(Set<String> dimensions)

window

public TimeSeriesAggregationQuery window(long resolution)

Defines the desired resolution.
If the desired resolution isn't a multiple of the source resolution it will floored to the closest valid resolution

Parameters:

resolution - the desired resolution in ms

Returns:

the builder

split

public TimeSeriesAggregationQuery split(long targetNumberOfBuckets)

Specifies the desired number of buckets in the result. - For targetNumberOfBuckets = 1 the resulting number of buckets will be exactly 1 - For targetNumberOfBuckets > 1 the resulting number of buckets will be as close as possible to the specified target

Parameters:

targetNumberOfBuckets - the desired number of buckets in the result

Returns:

the builder

getFilters

protected Map<String,String> getFilters()

getGroupDimensions

protected Set<String> getGroupDimensions()

getBucketIndexFrom

protected Long getBucketIndexFrom()

getBucketIndexTo

protected Long getBucketIndexTo()

drawAxis

protected List<Long> drawAxis()

getProjectionFunction

protected Function<Long,Long> getProjectionFunction()

getBucketSize

protected long getBucketSize()

run

public TimeSeriesAggregationResponse run()