TSNRangeParams (Jedis 8.0.0 API)

java.lang.Object
- redis.clients.jedis.timeseries.TSNRangeParams

All Implemented Interfaces:

IParams
```
public class TSNRangeParams
extends java.lang.Object
implements IParams
```
Represents optional arguments of the multi-key pivot commands TS.NRANGE and TS.NREVRANGE.
The command keys (numkeys key [key ...]) are supplied through the command method and are not part of these params; this object carries only fromTimestamp/toTimestamp and the optional range arguments, which are emitted on the wire in the canonical order documented on addParams(CommandArguments).

Since:

8.0

Constructor Summary

Constructors
Constructor and Description

TSNRangeParams()

TSNRangeParams(long fromTimestamp, long toTimestamp)

Constructors
Constructor and Description
`TSNRangeParams()`
`TSNRangeParams(long fromTimestamp, long toTimestamp)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addParams(CommandArguments args)` Emits, in order: `fromTimestamp toTimestamp` (defaulting to the `-`/`+` sentinels), then the optional tokens `LATEST`, `FILTER_BY_TS`, `FILTER_BY_VALUE`, `COUNT`, and the aggregation clause ({@code [ALIGN align] AGGREGATION agg [agg ...]
`TSNRangeParams`	`aggregation(AggregationType[][] aggregators, long bucketDuration)` Applies one or more aggregators per key, in key order.
`TSNRangeParams`	`aggregation(AggregationType[] aggregators, long bucketDuration)` Applies exactly one aggregator per key, in key order.
`TSNRangeParams`	`align(long timestamp)` This requires AGGREGATION.
`TSNRangeParams`	`alignEnd()` This requires AGGREGATION.
`TSNRangeParams`	`alignStart()` This requires AGGREGATION.
`TSNRangeParams`	`bucketTimestamp(java.lang.String bucketTimestamp)` This requires AGGREGATION.
`TSNRangeParams`	`bucketTimestampHigh()` This requires AGGREGATION.
`TSNRangeParams`	`bucketTimestampLow()` This requires AGGREGATION.
`TSNRangeParams`	`bucketTimestampMid()` This requires AGGREGATION.
`TSNRangeParams`	`count(int count)`
`TSNRangeParams`	`empty()` This requires AGGREGATION.
`boolean`	`equals(java.lang.Object o)`
`TSNRangeParams`	`filterByTS(long... timestamps)`
`TSNRangeParams`	`filterByValues(double min, double max)`
`TSNRangeParams`	`fromTimestamp(long fromTimestamp)`
`int`	`hashCode()`
`TSNRangeParams`	`latest()`
`static TSNRangeParams`	`nrangeParams()`
`static TSNRangeParams`	`nrangeParams(long fromTimestamp, long toTimestamp)`
`TSNRangeParams`	`toTimestamp(long toTimestamp)`
`void`	`validateAggregationForKeys(int numKeys)` Validates this aggregation configuration against the actual number of command keys.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TSNRangeParams
```
public TSNRangeParams(long fromTimestamp,
                      long toTimestamp)
```
  - TSNRangeParams
```
public TSNRangeParams()
```
- Method Detail
  - nrangeParams
```
public static TSNRangeParams nrangeParams(long fromTimestamp,
                                          long toTimestamp)
```
  - nrangeParams
```
public static TSNRangeParams nrangeParams()
```
  - fromTimestamp
```
public TSNRangeParams fromTimestamp(long fromTimestamp)
```
  - toTimestamp
```
public TSNRangeParams toTimestamp(long toTimestamp)
```
  - latest
```
public TSNRangeParams latest()
```
  - filterByTS
```
public TSNRangeParams filterByTS(long... timestamps)
```
  - filterByValues
```
public TSNRangeParams filterByValues(double min,
                                     double max)
```
  - count
```
public TSNRangeParams count(int count)
```
  - align
```
public TSNRangeParams align(long timestamp)
```
    This requires AGGREGATION.
  - alignStart
```
public TSNRangeParams alignStart()
```
    This requires AGGREGATION.
  - alignEnd
```
public TSNRangeParams alignEnd()
```
    This requires AGGREGATION.
  - aggregation
```
public TSNRangeParams aggregation(AggregationType[] aggregators,
                                  long bucketDuration)
```
    Applies exactly one aggregator per key, in key order. The number of aggregators must equal the number of keys sent to the command (the server rejects a mismatch). On the wire each aggregator is emitted as its own AGGREGATION token.
    
    Parameters:
    
    aggregators - ordered, non-empty list holding one aggregator per key
    
    bucketDuration - aggregation bucket duration in milliseconds
    
    Returns:
    
    this
    
    Throws:
    
    java.lang.IllegalArgumentException - if aggregators is empty or contains a null element
  - aggregation
```
public TSNRangeParams aggregation(AggregationType[][] aggregators,
                                  long bucketDuration)
```
    Applies one or more aggregators per key, in key order. The outer array length must equal the number of keys sent to the command (the server rejects a mismatch); each inner array holds the aggregators for that key and is emitted as a single comma-joined AGGREGATION token (e.g. AVG,MAX). The response returns one value column per aggregator, flattened in key then aggregator order.
    
    Parameters:
    
    aggregators - ordered, non-empty per-key lists of aggregators
    
    bucketDuration - aggregation bucket duration in milliseconds
    
    Returns:
    
    this
    
    Throws:
    
    java.lang.IllegalArgumentException - if aggregators (or any inner array) is empty or contains a null element
  - validateAggregationForKeys
```
public void validateAggregationForKeys(int numKeys)
```
    Validates this aggregation configuration against the actual number of command keys. TS.NRANGE/TS.NREVRANGE require exactly one aggregation spec per key, so when aggregation is set the number of specs must equal numKeys. This mirrors the server rule client-side so callers fail fast instead of relying on the the number of AGGREGATION arguments must be equal to numkeys error. No-op when aggregation is not set.
    
    Parameters:
    
    numKeys - number of keys passed to the command
    
    Throws:
    
    java.lang.IllegalArgumentException - if aggregation is set and the spec count differs from numKeys
  - bucketTimestamp
```
public TSNRangeParams bucketTimestamp(java.lang.String bucketTimestamp)
```
    This requires AGGREGATION.
  - bucketTimestampLow
```
public TSNRangeParams bucketTimestampLow()
```
    This requires AGGREGATION.
  - bucketTimestampHigh
```
public TSNRangeParams bucketTimestampHigh()
```
    This requires AGGREGATION.
  - bucketTimestampMid
```
public TSNRangeParams bucketTimestampMid()
```
    This requires AGGREGATION.
  - empty
```
public TSNRangeParams empty()
```
    This requires AGGREGATION.
  - addParams
```
public void addParams(CommandArguments args)
```
    Emits, in order: fromTimestamp toTimestamp (defaulting to the -/+ sentinels), then the optional tokens LATEST, FILTER_BY_TS, FILTER_BY_VALUE, COUNT, and the aggregation clause ([ALIGN align] AGGREGATION agg [agg ...] bucketDuration [BUCKETTIMESTAMP bt] [EMPTY]). One AGGREGATION token is emitted per key.
    
    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

Class TSNRangeParams

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TSNRangeParams

TSNRangeParams

Method Detail

nrangeParams

nrangeParams

fromTimestamp

toTimestamp

latest

filterByTS

filterByValues

count

align

alignStart

alignEnd

aggregation

aggregation

validateAggregationForKeys

bucketTimestamp

bucketTimestampLow

bucketTimestampHigh

bucketTimestampMid

empty

addParams

equals

hashCode