Package io.lettuce.core
Class TimeoutOptions.Builder
- java.lang.Object
-
- io.lettuce.core.TimeoutOptions.Builder
-
- Enclosing class:
- TimeoutOptions
public static class TimeoutOptions.Builder extends Object
Builder forTimeoutOptions
.
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TimeoutOptions
build()
Create a new instance ofTimeoutOptions
.TimeoutOptions.Builder
connectionTimeout()
Configure aTimeoutOptions.TimeoutSource
that applies timeouts configured on the connection/client instance.TimeoutOptions.Builder
fixedTimeout(Duration duration)
Set a fixed timeout for all commands.TimeoutOptions.Builder
timeoutCommands()
Enable command timeouts.TimeoutOptions.Builder
timeoutCommands(boolean enabled)
Configure whether commands should timeout.TimeoutOptions.Builder
timeoutSource(TimeoutOptions.TimeoutSource source)
Set aTimeoutOptions.TimeoutSource
to obtain the timeout value perRedisCommand
.
-
-
-
Method Detail
-
timeoutCommands
public TimeoutOptions.Builder timeoutCommands()
Enable command timeouts. Disabled by default, seeTimeoutOptions.DEFAULT_TIMEOUT_COMMANDS
.- Returns:
this
-
timeoutCommands
public TimeoutOptions.Builder timeoutCommands(boolean enabled)
Configure whether commands should timeout. Disabled by default, seeTimeoutOptions.DEFAULT_TIMEOUT_COMMANDS
.- Parameters:
enabled
-true
to enable timeout;false
to disable timeouts.- Returns:
this
-
fixedTimeout
public TimeoutOptions.Builder fixedTimeout(Duration duration)
Set a fixed timeout for all commands.- Parameters:
duration
- the timeoutDuration
, must not benull
.- Returns:
this
-
connectionTimeout
public TimeoutOptions.Builder connectionTimeout()
Configure aTimeoutOptions.TimeoutSource
that applies timeouts configured on the connection/client instance.- Returns:
this
-
timeoutSource
public TimeoutOptions.Builder timeoutSource(TimeoutOptions.TimeoutSource source)
Set aTimeoutOptions.TimeoutSource
to obtain the timeout value perRedisCommand
.- Parameters:
source
- the timeout source.- Returns:
this
-
build
public TimeoutOptions build()
Create a new instance ofTimeoutOptions
.- Returns:
- new instance of
TimeoutOptions
-
-