Package redis.clients.jedis.params

Class HGetExParams

java.lang.Object

redis.clients.jedis.params.HGetExParams

public class HGetExParams
extends java.lang.Object

Parameters for HGETEX command. Provides methods to set expiration options for the HGETEX command.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HGetExParams.ExpiryType

Constructor Summary

Constructors

Constructor	Description
HGetExParams()

Method Summary

Modifier and Type	Method	Description
HGetExParams	ex(long seconds)	Set the specified expire time, in seconds.
HGetExParams	exAt(long unixTimeSeconds)	Set the specified Unix time at which the key will expire, in seconds.
HGetExParams.ExpiryType	getExpirationType()	Get the expiration type.
java.lang.Long	getExpirationValue()	Get the expiration value.
static HGetExParams	hGetExParams()
HGetExParams	persist()	Remove the time to live associated with the key.
HGetExParams	px(long milliseconds)	Set the specified expire time, in milliseconds.
HGetExParams	pxAt(long unixTimeMilliseconds)	Set the specified Unix time at which the key will expire, in milliseconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

HGetExParams

public HGetExParams()

Method Detail

hGetExParams

public static HGetExParams hGetExParams()

ex

public HGetExParams ex(long seconds)

Set the specified expire time, in seconds.

Parameters:

seconds - seconds to expire

Returns:

HGetExParams instance

px

public HGetExParams px(long milliseconds)

Set the specified expire time, in milliseconds.

Parameters:

milliseconds - milliseconds to expire

Returns:

HGetExParams instance

exAt

public HGetExParams exAt(long unixTimeSeconds)

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

Parameters:

unixTimeSeconds - unix timestamp in seconds

Returns:

HGetExParams instance

pxAt

public HGetExParams pxAt(long unixTimeMilliseconds)

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

Parameters:

unixTimeMilliseconds - unix timestamp in milliseconds

Returns:

HGetExParams instance

persist

public HGetExParams persist()

Remove the time to live associated with the key.

Returns:

HGetExParams instance

getExpirationType

public HGetExParams.ExpiryType getExpirationType()

Get the expiration type.

Returns:

expiration type

getExpirationValue

public java.lang.Long getExpirationValue()

Get the expiration value.

Returns:

expiration value