Package org.redisson.api.options

Class OptionalParams

java.lang.Object

org.redisson.api.options.OptionalParams

All Implemented Interfaces:

CodecOptions<OptionalOptions,Codec>, InvocationOptions<OptionalOptions>, ObjectParams, OptionalOptions

public final class OptionalParams
extends Object
implements OptionalOptions

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
OptionalOptions	codec(Codec codec)	Defines codec used for data stored in Redis
Codec	getCodec()
int	getRetryAttempts()
DelayStrategy	getRetryDelay()
int	getTimeout()
OptionalOptions	retryAttempts(int retryAttempts)	Defines command retry attempts.
OptionalOptions	retryDelay(DelayStrategy interval)	Defines the delay strategy for a new attempt to send a command.
OptionalOptions	retryInterval(Duration interval)	Use InvocationOptions.retryDelay(DelayStrategy) instead.
OptionalOptions	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.CodecOptions

codec

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

retryAttempts, retryDelay, retryInterval, timeout

Method Details

codec

public OptionalOptions 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 OptionalOptions 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 OptionalOptions 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 OptionalOptions retryInterval(Duration interval)

Description copied from interface: InvocationOptions

Use InvocationOptions.retryDelay(DelayStrategy) instead.

Specified by:

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

Parameters:

interval - retry time interval

Returns:

options instance

retryDelay

public OptionalOptions retryDelay(DelayStrategy interval)

Description copied from interface: InvocationOptions

Defines the delay strategy for a new attempt to send a command.

Specified by:

retryDelay in interface InvocationOptions<T extends InvocationOptions<T>>

Parameters:

interval - delay strategy implementation

Returns:

options instance

getTimeout

public int getTimeout()

Specified by:

getTimeout in interface ObjectParams

getRetryAttempts

public int getRetryAttempts()

Specified by:

getRetryAttempts in interface ObjectParams

getCodec

public Codec getCodec()

getRetryDelay

public DelayStrategy getRetryDelay()

Specified by:

getRetryDelay in interface ObjectParams