redis.clients.jedis.timeseries

Class TSReadParams

java.lang.Object

redis.clients.jedis.timeseries.TSReadParams

All Implemented Interfaces:

IParams

public class TSReadParams
extends java.lang.Object
implements IParams

Represents the cursor and optional arguments of the TS.READ command.

Wire shape: TS.READ key timestamp [BLOCK milliseconds min_count] [MAX_COUNT max_count]. The cursor selects samples whose timestamp is greater than or equal to it, in ascending timestamp order. It is either a non-negative literal (Unix milliseconds) or one of the sentinels - (earliest), + (latest existing sample, inclusive) or $ (only samples added after the call). The sentinels are sent as-is and resolved by the server.

The BLOCK group is all-or-nothing: whenever blocking is requested both milliseconds and minCount are emitted. BLOCK 0 waits indefinitely.

Since:

8.0

Constructor Summary

Constructors

Constructor and Description
TSReadParams()

Method Summary

Modifier and Type	Method and Description
void	addParams(CommandArguments args)
TSReadParams	block(long milliseconds, int minCount) Opt into blocking.
TSReadParams	earliest() Cursor sentinel -: no lower bound, read from the earliest sample.
boolean	equals(java.lang.Object o)
int	hashCode()
boolean	isBlocking()
TSReadParams	latest() Cursor sentinel +: the latest existing sample's timestamp, inclusive.
TSReadParams	maxCount(int maxCount) Reply cap.
TSReadParams	newSamples() Cursor sentinel $: the latest sample's timestamp + 1, so only samples added after the command is received qualify.
static TSReadParams	readParams()
TSReadParams	timestamp(long timestamp) Literal cursor: samples with sample_timestamp >= timestamp qualify.

Methods inherited from class java.lang.Object

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

Constructor Detail

TSReadParams

public TSReadParams()

Method Detail

readParams

public static TSReadParams readParams()

timestamp

public TSReadParams timestamp(long timestamp)

Literal cursor: samples with sample_timestamp >= timestamp qualify. 0 reads from the beginning. Negative values are rejected by the server.

earliest

public TSReadParams earliest()

Cursor sentinel -: no lower bound, read from the earliest sample.

latest

public TSReadParams latest()

Cursor sentinel +: the latest existing sample's timestamp, inclusive. On an empty or missing series it resolves to 0.

newSamples

public TSReadParams newSamples()

Cursor sentinel $: the latest sample's timestamp + 1, so only samples added after the command is received qualify. Meaningful only together with block(long, int); without blocking it always yields an empty reply.

block

public TSReadParams block(long milliseconds,
                          int minCount)

Opt into blocking. Both values are always emitted on the wire inside the BLOCK group.

Parameters:

milliseconds - maximum wait, non-negative; 0 means wait indefinitely

minCount - unblock threshold, positive; the call returns once this many samples qualify

Returns:

this

maxCount

public TSReadParams maxCount(int maxCount)

Reply cap. When more samples qualify than maxCount, the oldest maxCount are returned so callers can page forward. Omitted means unlimited.

Parameters:

maxCount - positive integer

Returns:

this

isBlocking

public boolean isBlocking()

Returns:

true when the BLOCK group is present, so the command must be issued with blocking-command connection handling

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