io.lettuce.core

Class HSetExArgs

java.lang.Object

io.lettuce.core.HSetExArgs

All Implemented Interfaces:

CompositeArgument

public class HSetExArgs
extends Object
implements CompositeArgument

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

HSetExArgs 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	HSetExArgs.Builder Builder entry points for HSetExArgs.

Constructor Summary

Constructors

Constructor and Description
HSetExArgs()

Method Summary

Modifier and Type	Method and Description
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
HSetExArgs	ex(Duration timeout) Set the specified expire time, in seconds.
HSetExArgs	exAt(Instant timestamp) Set the specified expire at time using a posix timestamp.
HSetExArgs	fnx() Only set the key if it does not already exist.
HSetExArgs	fxx() Only set the key if it already exists.
HSetExArgs	keepttl() Set the value and retain the existing TTL.
HSetExArgs	px(Duration timeout) Set the specified expire time, in milliseconds.
HSetExArgs	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

HSetExArgs

public HSetExArgs()

Method Detail

ex

public HSetExArgs ex(Duration timeout)

Set the specified expire time, in seconds.

Parameters:

timeout - expire time in seconds.

Returns:

this HSetExArgs.

Since:

6.6

exAt

public HSetExArgs exAt(Instant timestamp)

Set the specified expire at time using a posix timestamp.

Parameters:

timestamp - the timestamp type: posix time in seconds.

Returns:

this HSetExArgs.

Since:

6.6

px

public HSetExArgs px(Duration timeout)

Set the specified expire time, in milliseconds.

Parameters:

timeout - expire time in milliseconds.

Returns:

this HSetExArgs.

pxAt

public HSetExArgs pxAt(Instant timestamp)

Set the specified expire at time using a posix timestamp.

Parameters:

timestamp - the timestamp type: posix time in milliseconds.

Returns:

this HSetExArgs.

Since:

6.6

fnx

public HSetExArgs fnx()

Only set the key if it does not already exist.

Returns:

this HSetExArgs.

keepttl

public HSetExArgs keepttl()

Set the value and retain the existing TTL.

Returns:

this HSetExArgs.

Since:

6.6

fxx

public HSetExArgs fxx()

Only set the key if it already exists.

Returns:

this HSetExArgs.

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.