| Package | Description |
|---|---|
| io.lettuce.core |
The Redis client package containing
RedisClient for Redis Standalone and Redis Sentinel operations. |
| io.lettuce.core.cluster |
Client for Redis Cluster, see
RedisClusterClient. |
| Modifier and Type | Method and Description |
|---|---|
ClientOptions.Builder |
ClientOptions.Builder.autoReconnect(boolean autoReconnect)
Enables or disables auto reconnection on connection loss.
|
static ClientOptions.Builder |
ClientOptions.builder()
Returns a new
ClientOptions.Builder to construct ClientOptions. |
ClientOptions.Builder |
ClientOptions.Builder.decodeBufferPolicy(DecodeBufferPolicy policy)
Set the policy to discard read bytes from the decoding aggregation buffer to reclaim memory.
|
ClientOptions.Builder |
ClientOptions.Builder.disconnectedBehavior(ClientOptions.DisconnectedBehavior disconnectedBehavior)
Sets the behavior for command invocation when connections are in a disconnected state.
|
ClientOptions.Builder |
ClientOptions.Builder.jsonParser(Supplier<JsonParser> parser)
Set a custom implementation for the
JsonParser to use. |
ClientOptions.Builder |
ClientOptions.Builder.maintNotificationsConfig(MaintNotificationsConfig maintNotificationsConfig)
Configure whether the driver should listen for server events that notify on current maintenance activities.
|
ClientOptions.Builder |
ClientOptions.mutate()
Returns a builder to create new
ClientOptions whose settings are replicated from the current
ClientOptions. |
ClientOptions.Builder |
ClientOptions.Builder.pingBeforeActivateConnection(boolean pingBeforeActivateConnection)
Perform a lightweight PING connection handshake when establishing a Redis connection.
|
ClientOptions.Builder |
ClientOptions.Builder.protocolVersion(ProtocolVersion protocolVersion)
Sets the
ProtocolVersion to use. |
ClientOptions.Builder |
ClientOptions.Builder.publishOnScheduler(boolean publishOnScheduler)
Use a dedicated
Scheduler to emit reactive data signals. |
ClientOptions.Builder |
ClientOptions.Builder.readOnlyCommands(ReadOnlyCommands.ReadOnlyPredicate readOnlyCommands)
Identifies commands (e.g. module commands) as read-only.
|
ClientOptions.Builder |
ClientOptions.Builder.reauthenticateBehavior(ClientOptions.ReauthenticateBehavior reauthenticateBehavior)
Configure the
ClientOptions.ReauthenticateBehavior of the Lettuce driver. |
ClientOptions.Builder |
ClientOptions.Builder.replayFilter(Predicate<RedisCommand<?,?,?>> replayFilter)
When
autoReconnect(boolean) is set to true, this Predicate is used to filter commands to replay when
the connection is reestablished after a disconnect. |
ClientOptions.Builder |
ClientOptions.Builder.requestQueueSize(int requestQueueSize)
Set the per-connection request queue size.
|
ClientOptions.Builder |
ClientOptions.Builder.scriptCharset(Charset scriptCharset)
|
ClientOptions.Builder |
ClientOptions.Builder.socketOptions(SocketOptions socketOptions)
Sets the low-level
SocketOptions for the connections kept to Redis servers. |
ClientOptions.Builder |
ClientOptions.Builder.sslOptions(SslOptions sslOptions)
Sets the
SslOptions for SSL connections kept to Redis servers. |
ClientOptions.Builder |
ClientOptions.Builder.suspendReconnectOnProtocolFailure(boolean suspendReconnectOnProtocolFailure)
Suspends reconnect when reconnects run into protocol failures (SSL verification, PING before connect fails).
|
ClientOptions.Builder |
ClientOptions.Builder.timeoutOptions(TimeoutOptions timeoutOptions)
Sets the
TimeoutOptions to expire and cancel commands. |
ClientOptions.Builder |
ClientOptions.Builder.useHashIndexQueue(boolean useHashIndexedQueue)
Use hash indexed queue, which provides O(1) remove(Object) thus won't cause blocking issues.
|
| Constructor and Description |
|---|
ClientOptions(ClientOptions.Builder builder) |
| Modifier and Type | Class and Description |
|---|---|
static class |
ClusterClientOptions.Builder
Builder for
ClusterClientOptions. |
Copyright © 2025 lettuce.io. All rights reserved.