io.lettuce.core

Class HGetExArgs

java.lang.Object

io.lettuce.core.HGetExArgs

All Implemented Interfaces:

CompositeArgument

public class HGetExArgs
extends Object
implements CompositeArgument

Argument list builder for the Redis HGETEX command starting from Redis 8.0. Static import the methods from HGetExArgs.Builder and chain the method calls: ex(10).nx().

HGetExArgs is a mutable object and instances should be used only once to avoid shared mutable state.

Since:

6.6

Author:

Ivo Gaydajiev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HGetExArgs.Builder Builder entry points for HGetExArgs.

Constructor Summary

Constructors

Constructor and Description
HGetExArgs()

Method Summary

Modifier and Type	Method and Description
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
HGetExArgs	ex(Duration timeout) Set the specified expire time, in seconds.
HGetExArgs	exAt(Instant timestamp) Set the specified expire at time using a posix timestamp.
HGetExArgs	persist() Remove the time to live associated with the key.
HGetExArgs	px(Duration timeout) Set the specified expire time, in milliseconds.
HGetExArgs	pxAt(Instant timestamp) Set the specified expire at time using a posix timestamp.

Methods inherited from class java.lang.Object

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

Constructor Detail

HGetExArgs

public HGetExArgs()

Method Detail

ex

public HGetExArgs ex(Duration timeout)

Set the specified expire time, in seconds.

Parameters:

timeout - expire time in seconds.

Returns:

this HGetExArgs.

Since:

6.6

exAt

public HGetExArgs exAt(Instant timestamp)

Set the specified expire at time using a posix timestamp.

Parameters:

timestamp - the timestamp type: posix time in seconds.

Returns:

this HGetExArgs.

Since:

6.6

px

public HGetExArgs px(Duration timeout)

Set the specified expire time, in milliseconds.

Parameters:

timeout - expire time in milliseconds.

Returns:

this HGetExArgs.

pxAt

public HGetExArgs pxAt(Instant timestamp)

Set the specified expire at time using a posix timestamp.

Parameters:

timestamp - the timestamp type: posix time in milliseconds.

Returns:

this HGetExArgs.

Since:

6.6

persist

public HGetExArgs persist()

Remove the time to live associated with the key.

Returns:

this HGetExArgs.

build

public <K,V> void build(CommandArgs<K,V> args)

Description copied from interface: CompositeArgument

Build command arguments and contribute arguments to CommandArgs.

Implementing classes are required to implement this method. Depending on the command nature and configured arguments, this method may contribute arguments but is not required to add arguments if none are specified.

Specified by:

build in interface CompositeArgument

Type Parameters:

K - Key type.

V - Value type.

Parameters:

args - the command arguments, must not be null.