redis.clients.jedis.params

Class HGetExParams

java.lang.Object

redis.clients.jedis.params.HGetExParams

All Implemented Interfaces:

IParams

public class HGetExParams
extends java.lang.Object

HGetExParams is a parameter class used when getting values of given keys in hash data with optionally setting/changing expiry time in Redis. It can be used to set the expiry time of the key in seconds or milliseconds.

This class includes the following methods:

• hGetExParams() - Static factory method to create a new instance of HGetExParams.
• 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.
• persist() - Remove the time-to-live associated with the key.

Example usage:

 
 HGetExParams params = HGetExParams.hGetExParams().persist();
 
 

See Also:

BaseGetExParams

Constructor Summary

Constructors

Constructor and Description
HGetExParams()

Method Summary

Modifier and Type	Method and Description
void	addParams(CommandArguments args)
boolean	equals(java.lang.Object o)
T	ex(long secondsToExpire) Set the specified expire time, in seconds.
T	exAt(long seconds) Set the specified Unix time at which the key will expire, in seconds.
int	hashCode()
static HGetExParams	hGetExParams()
T	persist() Remove the time to live associated with the key.
T	px(long millisecondsToExpire) Set the specified expire time, in milliseconds.
T	pxAt(long milliseconds) 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

HGetExParams

public HGetExParams()

Method Detail

hGetExParams

public static HGetExParams hGetExParams()

ex

public T ex(long secondsToExpire)

Set the specified expire time, in seconds.

Returns:

parameter object

px

public T px(long millisecondsToExpire)

Set the specified expire time, in milliseconds.

Returns:

parameter object

exAt

public T exAt(long seconds)

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

Parameters:

seconds -

Returns:

parameter object

pxAt

public T pxAt(long milliseconds)

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

Parameters:

milliseconds -

Returns:

parameter object

persist

public T persist()

Remove the time to live associated with the key.

Returns:

parameter object

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