Package redis.clients.jedis.params

Class HSetExParams

java.lang.Object

redis.clients.jedis.params.HSetExParams

public class HSetExParams
extends java.lang.Object

Parameters for HSETEX command. Provides methods to set expiration options and existence conditions for the HSETEX command.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HSetExParams.ExistenceCondition
static class	HSetExParams.ExpiryType

Constructor Summary

Constructors

Constructor	Description
HSetExParams()

Method Summary

Modifier and Type	Method	Description
HSetExParams	ex(long seconds)	Set the specified expire time, in seconds.
HSetExParams	exAt(long unixTimeSeconds)	Set the specified Unix time at which the key will expire, in seconds.
HSetExParams	fnx()	Only set the field if it does not already exist.
HSetExParams	fxx()	Only set the field if it already exists.
HSetExParams.ExistenceCondition	getExistenceCondition()	Get the existence condition.
HSetExParams.ExpiryType	getExpirationType()	Get the expiration type.
java.lang.Long	getExpirationValue()	Get the expiration value.
static HSetExParams	hSetExParams()
HSetExParams	keepTtl()	Retain the time to live associated with the key.
HSetExParams	px(long milliseconds)	Set the specified expire time, in milliseconds.
HSetExParams	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

HSetExParams

public HSetExParams()

Method Detail

hSetExParams

public static HSetExParams hSetExParams()

ex

public HSetExParams ex(long seconds)

Set the specified expire time, in seconds.

Parameters:

seconds - seconds to expire

Returns:

HSetExParams instance

px

public HSetExParams px(long milliseconds)

Set the specified expire time, in milliseconds.

Parameters:

milliseconds - milliseconds to expire

Returns:

HSetExParams instance

exAt

public HSetExParams exAt(long unixTimeSeconds)

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

Parameters:

unixTimeSeconds - unix timestamp in seconds

Returns:

HSetExParams instance

pxAt

public HSetExParams pxAt(long unixTimeMilliseconds)

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

Parameters:

unixTimeMilliseconds - unix timestamp in milliseconds

Returns:

HSetExParams instance

keepTtl

public HSetExParams keepTtl()

Retain the time to live associated with the key.

Returns:

HSetExParams instance

fnx

public HSetExParams fnx()

Only set the field if it does not already exist.

Returns:

HSetExParams instance

fxx

public HSetExParams fxx()

Only set the field if it already exists.

Returns:

HSetExParams instance

getExpirationType

public HSetExParams.ExpiryType getExpirationType()

Get the expiration type.

Returns:

expiration type

getExpirationValue

public java.lang.Long getExpirationValue()

Get the expiration value.

Returns:

expiration value

getExistenceCondition

public HSetExParams.ExistenceCondition getExistenceCondition()

Get the existence condition.

Returns:

existence condition