Package org.redisson.api.options

Class KeysParams

java.lang.Object

org.redisson.api.options.KeysParams

All Implemented Interfaces:

CodecOptions<KeysOptions,Codec>, InvocationOptions<KeysOptions>, KeysOptions, ObjectParams

public final class KeysParams
extends Object
implements KeysOptions

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
KeysOptions	codec(Codec codec)	Defines codec used for data stored in Redis
Codec	getCodec()
int	getRetryAttempts()
int	getRetryInterval()
int	getTimeout()
KeysOptions	retryAttempts(int retryAttempts)	Defines command retry attempts.
KeysOptions	retryInterval(Duration interval)	Defines time interval for another one attempt to send a Redis command if it hasn't already been sent.
KeysOptions	timeout(Duration timeout)	Defines Redis server response timeout.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.redisson.api.options.InvocationOptions

retryAttempts, retryInterval, timeout

Method Details

codec

public KeysOptions codec(Codec codec)

Description copied from interface: CodecOptions

Defines codec used for data stored in Redis

Specified by:

codec in interface CodecOptions<T extends InvocationOptions<T>,C>

Parameters:

codec - applied to object instance

Returns:

options object

timeout

public KeysOptions timeout(Duration timeout)

Description copied from interface: InvocationOptions

Defines Redis server response timeout. Starts to countdown when a Redis command was successfully sent.

Default is the value specified for the same parameter in Redisson configuration

Specified by:

timeout in interface InvocationOptions<T extends InvocationOptions<T>>

Parameters:

timeout - Redis server response timeout

Returns:

options instance

retryAttempts

public KeysOptions retryAttempts(int retryAttempts)

Description copied from interface: InvocationOptions

Defines command retry attempts. Error is thrown if the Redis command can't be sent to Redis server after retryAttempts. But if it sent successfully then responseTimeout is started.

Default is the value specified for the same parameter in Redisson configuration

Specified by:

retryAttempts in interface InvocationOptions<T extends InvocationOptions<T>>

Parameters:

retryAttempts - command retry attempts

Returns:

options instance

retryInterval

public KeysOptions retryInterval(Duration interval)

Description copied from interface: InvocationOptions

Defines time interval for another one attempt to send a Redis command if it hasn't already been sent.

Specified by:

retryInterval in interface InvocationOptions<T extends InvocationOptions<T>>

Parameters:

interval - retry time interval

Returns:

options instance

getTimeout

public int getTimeout()

Specified by:

getTimeout in interface ObjectParams

getRetryAttempts

public int getRetryAttempts()

Specified by:

getRetryAttempts in interface ObjectParams

getRetryInterval

public int getRetryInterval()

Specified by:

getRetryInterval in interface ObjectParams

getCodec

public Codec getCodec()