redis.clients.jedis.timeseries

Class TSMRangeParams

java.lang.Object

redis.clients.jedis.timeseries.TSMRangeParams

All Implemented Interfaces:

IParams

public class TSMRangeParams
extends java.lang.Object
implements IParams

Represents optional arguments of TS.MRANGE and TS.MREVRANGE commands.

Constructor Summary

Constructors

Constructor and Description
TSMRangeParams()
TSMRangeParams(long fromTimestamp, long toTimestamp)

Method Summary

Modifier and Type	Method and Description
void	addParams(CommandArguments args)
TSMRangeParams	aggregation(AggregationType[] aggregators, long bucketDuration) Specifies multiple aggregators to be applied in a single TS.MRANGE / TS.MREVRANGE call.
TSMRangeParams	aggregation(AggregationType aggregationType, long bucketDuration)
TSMRangeParams	align(long timestamp) This requires AGGREGATION.
TSMRangeParams	alignEnd() This requires AGGREGATION.
TSMRangeParams	alignStart() This requires AGGREGATION.
TSMRangeParams	bucketTimestamp(java.lang.String bucketTimestamp) This requires AGGREGATION.
TSMRangeParams	bucketTimestampHigh() This requires AGGREGATION.
TSMRangeParams	bucketTimestampLow() This requires AGGREGATION.
TSMRangeParams	bucketTimestampMid() This requires AGGREGATION.
TSMRangeParams	count(int count)
TSMRangeParams	empty() This requires AGGREGATION.
boolean	equals(java.lang.Object o)
TSMRangeParams	excludeEmpty() Omits matching time series with no reported samples for the queried range and options from the TS.MRANGE / TS.MREVRANGE reply by sending the EXCLUDEEMPTY flag.
TSMRangeParams	filter(java.lang.String... filters)
TSMRangeParams	filterByTS(long... timestamps)
TSMRangeParams	filterByValues(double min, double max)
TSMRangeParams	fromTimestamp(long fromTimestamp)
TSMRangeParams	groupBy(java.lang.String label, java.lang.String reduce)
int	hashCode()
TSMRangeParams	latest()
static TSMRangeParams	multiRangeParams()
static TSMRangeParams	multiRangeParams(long fromTimestamp, long toTimestamp)
TSMRangeParams	selectedLabels(java.lang.String... labels)
TSMRangeParams	toTimestamp(long toTimestamp)
TSMRangeParams	withLabels()
TSMRangeParams	withLabels(boolean withLabels)

Methods inherited from class java.lang.Object

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

Constructor Detail

TSMRangeParams

public TSMRangeParams(long fromTimestamp,
                      long toTimestamp)

TSMRangeParams

public TSMRangeParams()

Method Detail

multiRangeParams

public static TSMRangeParams multiRangeParams(long fromTimestamp,
                                              long toTimestamp)

multiRangeParams

public static TSMRangeParams multiRangeParams()

fromTimestamp

public TSMRangeParams fromTimestamp(long fromTimestamp)

toTimestamp

public TSMRangeParams toTimestamp(long toTimestamp)

latest

public TSMRangeParams latest()

filterByTS

public TSMRangeParams filterByTS(long... timestamps)

filterByValues

public TSMRangeParams filterByValues(double min,
                                     double max)

withLabels

public TSMRangeParams withLabels(boolean withLabels)

withLabels

public TSMRangeParams withLabels()

selectedLabels

public TSMRangeParams selectedLabels(java.lang.String... labels)

count

public TSMRangeParams count(int count)

align

public TSMRangeParams align(long timestamp)

This requires AGGREGATION.

alignStart

public TSMRangeParams alignStart()

This requires AGGREGATION.

alignEnd

public TSMRangeParams alignEnd()

This requires AGGREGATION.

aggregation

public TSMRangeParams aggregation(AggregationType aggregationType,
                                  long bucketDuration)

aggregation

public TSMRangeParams aggregation(AggregationType[] aggregators,
                                  long bucketDuration)

Specifies multiple aggregators to be applied in a single TS.MRANGE / TS.MREVRANGE call. Aggregators are sent on the wire in the given order and the response values appear in the same order in TSElement.getValues(). Single-element arrays are accepted and behave like aggregation(AggregationType, long).

Parameters:

aggregators - ordered, non-empty list of aggregators

bucketDuration - aggregation bucket duration in milliseconds

Returns:

this

Throws:

java.lang.IllegalArgumentException - if aggregators is empty

bucketTimestamp

public TSMRangeParams bucketTimestamp(java.lang.String bucketTimestamp)

This requires AGGREGATION.

bucketTimestampLow

public TSMRangeParams bucketTimestampLow()

This requires AGGREGATION.

bucketTimestampHigh

public TSMRangeParams bucketTimestampHigh()

This requires AGGREGATION.

bucketTimestampMid

public TSMRangeParams bucketTimestampMid()

This requires AGGREGATION.

empty

public TSMRangeParams empty()

This requires AGGREGATION.

excludeEmpty

public TSMRangeParams excludeEmpty()

Omits matching time series with no reported samples for the queried range and options from the TS.MRANGE / TS.MREVRANGE reply by sending the EXCLUDEEMPTY flag.

By default, matching series can be returned with an empty samples array. When enabled, a matching series is returned only when the command reports at least one sample for that series; if every matching series is empty, the reply is an empty array.

This flag must not be combined with groupBy(String, String).

Returns:

this

Since:

8.0

filter

public TSMRangeParams filter(java.lang.String... filters)

groupBy

public TSMRangeParams groupBy(java.lang.String label,
                              java.lang.String reduce)

addParams

public void addParams(CommandArguments args)

Specified by:

addParams in interface IParams

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object