redis.clients.jedis.params

Class HSetExParams

java.lang.Object

redis.clients.jedis.params.HSetExParams

All Implemented Interfaces:

IParams

public class HSetExParams
extends java.lang.Object

HSetExParams is a parameter class used when setting key-value pairs of hash data with optional expiry and existance conditions in Redis. It provides methods to specify whether the key should be set only if it already exists or only if it does not already exist. It can also be used to set the expiry time of the key in seconds or milliseconds.

This class includes the following methods:

• hSetExParams() - Static factory method to create a new instance of HSetExParams.
• fnx() - Sets the condition to only set the key if it does not already exist.
• fxx() - Sets the condition to only set the key if it already exists.
• ex(long) - Set the specified expire time, in seconds.
• px(long) - Set the specified expire time, in milliseconds.
• exAt(long) - Set the specified Unix(epoch) time at which the key will expire, in seconds.
• pxAt(long) - Set the specified Unix(epoch) time at which the key will expire, in milliseconds.
• keepTtl() - Retain the time to live associated with the key.

Example usage:

 
 HSetExParams params = HSetExParams.hSetExParams().fnx();
 
 

See Also:

BaseSetExParams

Constructor Summary

Constructors

Constructor and Description
HSetExParams()

Method Summary

Modifier and Type	Method and Description
void	addParams(CommandArguments args)
boolean	equals(java.lang.Object o)
T	ex(long remainingSeconds) Set the specified expire time, in seconds.
T	exAt(long timestampSeconds) Set the specified Unix time at which the key will expire, in seconds.
HSetExParams	fnx() Only set the key if it does not already exist.
HSetExParams	fxx() Only set the key if it already exist.
int	hashCode()
static HSetExParams	hSetExParams()
T	keepttl() Deprecated. Use BaseSetExParams.keepTtl().
T	keepTtl() Retain the time to live associated with the key.
T	px(long remainingMilliseconds) Set the specified expire time, in milliseconds.
T	pxAt(long timestampMilliseconds) Set the specified Unix time at which the key will expire, in milliseconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

HSetExParams

public HSetExParams()

Method Detail

hSetExParams

public static HSetExParams hSetExParams()

fnx

public HSetExParams fnx()

Only set the key if it does not already exist.

Returns:

HSetExParams

fxx

public HSetExParams fxx()

Only set the key if it already exist.

Returns:

HSetExParams

addParams

public void addParams(CommandArguments args)

Specified by:

addParams in interface IParams

equals

public boolean equals(java.lang.Object o)

hashCode

public int hashCode()

ex

public T ex(long remainingSeconds)

Set the specified expire time, in seconds.

Parameters:

remainingSeconds -

Returns:

params object

px

public T px(long remainingMilliseconds)

Set the specified expire time, in milliseconds.

Parameters:

remainingMilliseconds -

Returns:

params object

exAt

public T exAt(long timestampSeconds)

Set the specified Unix time at which the key will expire, in seconds.

Parameters:

timestampSeconds -

Returns:

params object

pxAt

public T pxAt(long timestampMilliseconds)

Set the specified Unix time at which the key will expire, in milliseconds.

Parameters:

timestampMilliseconds -

Returns:

params object

keepttl

@Deprecated
public T keepttl()

Deprecated. Use BaseSetExParams.keepTtl().

Returns:

params object

keepTtl

public T keepTtl()

Retain the time to live associated with the key.

Returns:

params object