java.lang.Object
- io.lettuce.core.ClientOptions.Builder
- - io.lettuce.core.cluster.ClusterClientOptions.Builder

Enclosing class:: ClusterClientOptions

public static class ClusterClientOptions.Builder
extends ClientOptions.Builder

Builder for ClusterClientOptions.

Constructor Summary

Constructors
Modifier Constructor Description

protected Builder()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`ClusterClientOptions.Builder`	`autoReconnect(boolean autoReconnect)`	Enables or disables auto reconnection on connection loss.
`ClusterClientOptions.Builder`	`bufferUsageRatio(int bufferUsageRatio)`	Deprecated. since 6.0 in favor of `DecodeBufferPolicy`.
`ClusterClientOptions`	`build()`	Create a new instance of `ClusterClientOptions`
`ClusterClientOptions.Builder`	`cancelCommandsOnReconnectFailure(boolean cancelCommandsOnReconnectFailure)`	Deprecated. since 6.2, to be removed with 7.0.
`ClusterClientOptions.Builder`	`decodeBufferPolicy(DecodeBufferPolicy decodeBufferPolicy)`	Set the policy to discard read bytes from the decoding aggregation buffer to reclaim memory.
`ClusterClientOptions.Builder`	`disconnectedBehavior(ClientOptions.DisconnectedBehavior disconnectedBehavior)`	Sets the behavior for command invocation when connections are in a disconnected state.
`ClusterClientOptions.Builder`	`maxRedirects(int maxRedirects)`	Number of maximal cluster redirects (-MOVED and -ASK) to follow in case a key was moved from one node to another node.
`ClusterClientOptions.Builder`	`nodeFilter(Predicate<RedisClusterNode> nodeFilter)`	Provide a `node filter` to filter cluster nodes from `Partitions`.
`ClusterClientOptions.Builder`	`pingBeforeActivateConnection(boolean pingBeforeActivateConnection)`	Perform a lightweight PING connection handshake when establishing a Redis connection.
`ClusterClientOptions.Builder`	`protocolVersion(ProtocolVersion protocolVersion)`	Sets the `ProtocolVersion` to use.
`ClusterClientOptions.Builder`	`publishOnScheduler(boolean publishOnScheduler)`	Use a dedicated `Scheduler` to emit reactive data signals.
`ClusterClientOptions.Builder`	`readOnlyCommands(ReadOnlyCommands.ReadOnlyPredicate readOnlyCommands)`	Identifies commands (e.g.
`ClusterClientOptions.Builder`	`requestQueueSize(int requestQueueSize)`	Set the per-connection request queue size.
`ClusterClientOptions.Builder`	`scriptCharset(Charset scriptCharset)`	Sets the Lua script `Charset` to use to encode `scripts` to `byte[]`.
`ClusterClientOptions.Builder`	`socketOptions(SocketOptions socketOptions)`	Sets the low-level `SocketOptions` for the connections kept to Redis servers.
`ClusterClientOptions.Builder`	`sslOptions(SslOptions sslOptions)`	Sets the `SslOptions` for SSL connections kept to Redis servers.
`ClusterClientOptions.Builder`	`suspendReconnectOnProtocolFailure(boolean suspendReconnectOnProtocolFailure)`	Suspends reconnect when reconnects run into protocol failures (SSL verification, PING before connect fails).
`ClusterClientOptions.Builder`	`timeoutOptions(TimeoutOptions timeoutOptions)`	Sets the `TimeoutOptions` to expire and cancel commands.
`ClusterClientOptions.Builder`	`topologyRefreshOptions(ClusterTopologyRefreshOptions topologyRefreshOptions)`	Sets the `ClusterTopologyRefreshOptions` for detailed control of topology updates.
`ClusterClientOptions.Builder`	`validateClusterNodeMembership(boolean validateClusterNodeMembership)`	Validate the cluster node membership before allowing connections to a cluster node.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
protected Builder()
```
- Method Detail
  - autoReconnect
```
public ClusterClientOptions.Builder autoReconnect(boolean autoReconnect)
```
    Description copied from class: ClientOptions.Builder
    
    Enables or disables auto reconnection on connection loss. Defaults to true. See ClientOptions.DEFAULT_AUTO_RECONNECT.
    
    Overrides:
    
    autoReconnect in class ClientOptions.Builder
    
    Parameters:
    
    autoReconnect - true/false
    
    Returns:
    
    this
  - bufferUsageRatio
```
@Deprecated
public ClusterClientOptions.Builder bufferUsageRatio(int bufferUsageRatio)
```
    Deprecated.
    since 6.0 in favor of DecodeBufferPolicy.
    
    Description copied from class: ClientOptions.Builder
    
    Buffer usage ratio for CommandHandler. This ratio controls how often bytes are discarded during decoding. In particular, when buffer usage reaches bufferUsageRatio / bufferUsageRatio + 1. E.g. setting bufferUsageRatio to 3, will discard read bytes once the buffer usage reaches 75 percent. See ClientOptions.DEFAULT_BUFFER_USAGE_RATIO.
    
    Overrides:
    
    bufferUsageRatio in class ClientOptions.Builder
    
    Parameters:
    
    bufferUsageRatio - the buffer usage ratio. Must be between 0 and 2^31-1, typically a value between 1 and 10 representing 50% to 90%.
    
    Returns:
    
    this
  - cancelCommandsOnReconnectFailure
```
@Deprecated
public ClusterClientOptions.Builder cancelCommandsOnReconnectFailure(boolean cancelCommandsOnReconnectFailure)
```
    Deprecated.
    since 6.2, to be removed with 7.0. This feature is unsafe and may cause protocol offsets if true (i.e. Redis commands are completed with previous command values).
    
    Description copied from class: ClientOptions.Builder
    
    Allows cancelling queued commands in case a reconnect fails.Defaults to false. See ClientOptions.DEFAULT_CANCEL_CMD_RECONNECT_FAIL. This flag is deprecated and should not be used as it can lead to race conditions and protocol offsets. The reason is that it internally calls reset() which causes a protocol offset. See StatefulConnection.reset()
    
    Overrides:
    
    cancelCommandsOnReconnectFailure in class ClientOptions.Builder
    
    Parameters:
    
    cancelCommandsOnReconnectFailure - true/false
    
    Returns:
  - decodeBufferPolicy
```
public ClusterClientOptions.Builder decodeBufferPolicy(DecodeBufferPolicy decodeBufferPolicy)
```
    Description copied from class: ClientOptions.Builder
    
    Set the policy to discard read bytes from the decoding aggregation buffer to reclaim memory.
    
    Overrides:
    
    decodeBufferPolicy in class ClientOptions.Builder
    
    Parameters:
    
    decodeBufferPolicy - the policy to use in CommandHandler
    
    Returns:
    
    this
    
    See Also:
    
    DecodeBufferPolicies
  - disconnectedBehavior
```
public ClusterClientOptions.Builder disconnectedBehavior(ClientOptions.DisconnectedBehavior disconnectedBehavior)
```
    Description copied from class: ClientOptions.Builder
    
    Sets the behavior for command invocation when connections are in a disconnected state. Defaults to true. See ClientOptions.DEFAULT_DISCONNECTED_BEHAVIOR.
    
    Overrides:
    
    disconnectedBehavior in class ClientOptions.Builder
    
    Parameters:
    
    disconnectedBehavior - must not be null.
    
    Returns:
    
    this
  - maxRedirects
```
public ClusterClientOptions.Builder maxRedirects(int maxRedirects)
```
    Number of maximal cluster redirects (-MOVED and -ASK) to follow in case a key was moved from one node to another node. Defaults to 5. See ClusterClientOptions.DEFAULT_MAX_REDIRECTS.
    
    Parameters:
    
    maxRedirects - the limit of maximal cluster redirects
    
    Returns:
    
    this
  - pingBeforeActivateConnection
```
public ClusterClientOptions.Builder pingBeforeActivateConnection(boolean pingBeforeActivateConnection)
```
    Description copied from class: ClientOptions.Builder
    
    Perform a lightweight PING connection handshake when establishing a Redis connection. If true (default is true, ClientOptions.DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION), every connection and reconnect will issue a PING command and await its response before the connection is activated and enabled for use. If the check fails, the connect/reconnect is treated as a failure. This option has no effect unless forced to use the RESP 2 protocol version. RESP 3/protocol discovery performs a HELLO handshake.
    The PING handshake validates whether the other end of the connected socket is a service that behaves like a Redis server.
    
    Overrides:
    
    pingBeforeActivateConnection in class ClientOptions.Builder
    
    Parameters:
    
    pingBeforeActivateConnection - true/false
    
    Returns:
    
    this
  - protocolVersion
```
public ClusterClientOptions.Builder protocolVersion(ProtocolVersion protocolVersion)
```
    Description copied from class: ClientOptions.Builder
    
    Sets the ProtocolVersion to use. Defaults to RESP3. See ClientOptions.DEFAULT_PROTOCOL_VERSION.
    
    Overrides:
    
    protocolVersion in class ClientOptions.Builder
    
    Parameters:
    
    protocolVersion - version to use.
    
    Returns:
    
    this
    
    See Also:
    
    ProtocolVersion.newestSupported()
  - suspendReconnectOnProtocolFailure
```
public ClusterClientOptions.Builder suspendReconnectOnProtocolFailure(boolean suspendReconnectOnProtocolFailure)
```
    Description copied from class: ClientOptions.Builder
    
    Suspends reconnect when reconnects run into protocol failures (SSL verification, PING before connect fails). Defaults to false. See ClientOptions.DEFAULT_SUSPEND_RECONNECT_PROTO_FAIL.
    
    Overrides:
    
    suspendReconnectOnProtocolFailure in class ClientOptions.Builder
    
    Parameters:
    
    suspendReconnectOnProtocolFailure - true/false
    
    Returns:
    
    this
  - publishOnScheduler
```
public ClusterClientOptions.Builder publishOnScheduler(boolean publishOnScheduler)
```
    Description copied from class: ClientOptions.Builder
    
    Use a dedicated Scheduler to emit reactive data signals. Enabling this option can be useful for reactive sequences that require a significant amount of processing with a single/a few Redis connections.
    A single Redis connection operates on a single thread. Operations that require a significant amount of processing can lead to a single-threaded-like behavior for all consumers of the Redis connection. When enabled, data signals will be emitted using a different thread served by ClientResources.eventExecutorGroup(). Defaults to false , see ClientOptions.DEFAULT_PUBLISH_ON_SCHEDULER.
    
    Overrides:
    
    publishOnScheduler in class ClientOptions.Builder
    
    Parameters:
    
    publishOnScheduler - true/false
    
    Returns:
    
    this
    
    See Also:
    
    Subscriber.onNext(Object), ClientResources.eventExecutorGroup()
  - readOnlyCommands
```
public ClusterClientOptions.Builder readOnlyCommands(ReadOnlyCommands.ReadOnlyPredicate readOnlyCommands)
```
    Description copied from class: ClientOptions.Builder
    
    Identifies commands (e.g. module commands) as read-only. Defaults ClientOptions.DEFAULT_READ_ONLY_COMMANDS, see ReadOnlyCommands.
    
    Overrides:
    
    readOnlyCommands in class ClientOptions.Builder
    
    Parameters:
    
    readOnlyCommands - must not be null.
    
    Returns:
    
    this
  - requestQueueSize
```
public ClusterClientOptions.Builder requestQueueSize(int requestQueueSize)
```
    Description copied from class: ClientOptions.Builder
    
    Set the per-connection request queue size. The command invocation will lead to a RedisException if the queue size is exceeded. Setting the requestQueueSize to a lower value will lead earlier to exceptions during overload or while the connection is in a disconnected state. A higher value means hitting the boundary will take longer to occur, but more requests will potentially be queued up and more heap space is used. Defaults to Integer.MAX_VALUE. See ClientOptions.DEFAULT_REQUEST_QUEUE_SIZE.
    
    Overrides:
    
    requestQueueSize in class ClientOptions.Builder
    
    Parameters:
    
    requestQueueSize - the queue size.
    
    Returns:
    
    this
  - scriptCharset
```
public ClusterClientOptions.Builder scriptCharset(Charset scriptCharset)
```
    Description copied from class: ClientOptions.Builder
    
    Sets the Lua script Charset to use to encode scripts to byte[]. Defaults to StandardCharsets.UTF_8. See ClientOptions.DEFAULT_SCRIPT_CHARSET.
    
    Overrides:
    
    scriptCharset in class ClientOptions.Builder
    
    Parameters:
    
    scriptCharset - must not be null.
    
    Returns:
    
    this
  - socketOptions
```
public ClusterClientOptions.Builder socketOptions(SocketOptions socketOptions)
```
    Description copied from class: ClientOptions.Builder
    
    Sets the low-level SocketOptions for the connections kept to Redis servers. See ClientOptions.DEFAULT_SOCKET_OPTIONS.
    
    Overrides:
    
    socketOptions in class ClientOptions.Builder
    
    Parameters:
    
    socketOptions - must not be null.
    
    Returns:
    
    this
  - sslOptions
```
public ClusterClientOptions.Builder sslOptions(SslOptions sslOptions)
```
    Description copied from class: ClientOptions.Builder
    
    Sets the SslOptions for SSL connections kept to Redis servers. See ClientOptions.DEFAULT_SSL_OPTIONS.
    
    Overrides:
    
    sslOptions in class ClientOptions.Builder
    
    Parameters:
    
    sslOptions - must not be null.
    
    Returns:
    
    this
  - timeoutOptions
```
public ClusterClientOptions.Builder timeoutOptions(TimeoutOptions timeoutOptions)
```
    Description copied from class: ClientOptions.Builder
    
    Sets the TimeoutOptions to expire and cancel commands. See ClientOptions.DEFAULT_TIMEOUT_OPTIONS.
    
    Overrides:
    
    timeoutOptions in class ClientOptions.Builder
    
    Parameters:
    
    timeoutOptions - must not be null.
    
    Returns:
    
    this
  - topologyRefreshOptions
```
public ClusterClientOptions.Builder topologyRefreshOptions(ClusterTopologyRefreshOptions topologyRefreshOptions)
```
    Sets the ClusterTopologyRefreshOptions for detailed control of topology updates.
    
    Parameters:
    
    topologyRefreshOptions - the ClusterTopologyRefreshOptions
    
    Returns:
    
    this
  - validateClusterNodeMembership
```
public ClusterClientOptions.Builder validateClusterNodeMembership(boolean validateClusterNodeMembership)
```
    Validate the cluster node membership before allowing connections to a cluster node. Defaults to true. See ClusterClientOptions.DEFAULT_VALIDATE_CLUSTER_MEMBERSHIP.
    
    Parameters:
    
    validateClusterNodeMembership - true if validation is enabled.
    
    Returns:
    
    this
  - nodeFilter
```
public ClusterClientOptions.Builder nodeFilter(Predicate<RedisClusterNode> nodeFilter)
```
    Provide a node filter to filter cluster nodes from Partitions.
    
    Parameters:
    
    nodeFilter - must not be null.
    
    Returns:
    
    this
    
    Since:
    
    6.1.6
  - build
```
public ClusterClientOptions build()
```
    Create a new instance of ClusterClientOptions
    
    Overrides:
    
    build in class ClientOptions.Builder
    
    Returns:
    
    new instance of ClusterClientOptions

Class ClusterClientOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

autoReconnect

bufferUsageRatio

cancelCommandsOnReconnectFailure

decodeBufferPolicy

disconnectedBehavior

maxRedirects

pingBeforeActivateConnection

protocolVersion

suspendReconnectOnProtocolFailure

publishOnScheduler

readOnlyCommands

requestQueueSize

scriptCharset

socketOptions

sslOptions

timeoutOptions

topologyRefreshOptions

validateClusterNodeMembership

nodeFilter

build