ClientOptions.Builder (Lettuce 6.1.4.RELEASE API)

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

Direct Known Subclasses:

ClusterClientOptions.Builder

Enclosing class:

ClientOptions
```
public static class ClientOptions.Builder
extends Object
```
Builder for ClientOptions.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Builder()

Constructors
Modifier	Constructor and Description
`protected`	`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ClientOptions.Builder`	`autoReconnect(boolean autoReconnect)` Enables or disables auto reconnection on connection loss.
`ClientOptions.Builder`	`bufferUsageRatio(int bufferUsageRatio)` Deprecated. since 6.0 in favor of `DecodeBufferPolicy`.
`ClientOptions`	`build()` Create a new instance of `ClientOptions`.
`ClientOptions.Builder`	`cancelCommandsOnReconnectFailure(boolean cancelCommandsOnReconnectFailure)` Allows cancelling queued commands in case a reconnect fails.Defaults to `false`.
`ClientOptions.Builder`	`decodeBufferPolicy(DecodeBufferPolicy policy)` Set the policy to discard read bytes from the decoding aggregation buffer to reclaim memory.
`ClientOptions.Builder`	`disconnectedBehavior(ClientOptions.DisconnectedBehavior disconnectedBehavior)` Sets the behavior for command invocation when connections are in a disconnected state.
`ClientOptions.Builder`	`pingBeforeActivateConnection(boolean pingBeforeActivateConnection)` Sets the PING before activate connection flag.
`ClientOptions.Builder`	`protocolVersion(ProtocolVersion protocolVersion)` Sets the `ProtocolVersion` to use.
`ClientOptions.Builder`	`publishOnScheduler(boolean publishOnScheduler)` Use a dedicated `Scheduler` to emit reactive data signals.
`ClientOptions.Builder`	`requestQueueSize(int requestQueueSize)` Set the per-connection request queue size.
`ClientOptions.Builder`	`scriptCharset(Charset scriptCharset)` Sets the Lua script `Charset` to use to encode `scripts` to `byte[]`.
`ClientOptions.Builder`	`socketOptions(SocketOptions socketOptions)` Sets the low-level `SocketOptions` for the connections kept to Redis servers.
`ClientOptions.Builder`	`sslOptions(SslOptions sslOptions)` Sets the `SslOptions` for SSL connections kept to Redis servers.
`ClientOptions.Builder`	`suspendReconnectOnProtocolFailure(boolean suspendReconnectOnProtocolFailure)` Suspends reconnect when reconnects run into protocol failures (SSL verification, PING before connect fails).
`ClientOptions.Builder`	`timeoutOptions(TimeoutOptions timeoutOptions)` Sets the `TimeoutOptions` to expire and cancel commands.

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 ClientOptions.Builder autoReconnect(boolean autoReconnect)
```
    Enables or disables auto reconnection on connection loss. Defaults to true. See ClientOptions.DEFAULT_AUTO_RECONNECT.
    
    Parameters:
    
    autoReconnect - true/false
    
    Returns:
    
    this
  - cancelCommandsOnReconnectFailure
```
public ClientOptions.Builder cancelCommandsOnReconnectFailure(boolean cancelCommandsOnReconnectFailure)
```
    Allows cancelling queued commands in case a reconnect fails.Defaults to false. See ClientOptions.DEFAULT_CANCEL_CMD_RECONNECT_FAIL.
    
    Parameters:
    
    cancelCommandsOnReconnectFailure - true/false
    
    Returns:
    
    this
  - bufferUsageRatio
```
@Deprecated
public ClientOptions.Builder bufferUsageRatio(int bufferUsageRatio)
```
    Deprecated. since 6.0 in favor of DecodeBufferPolicy.
    
    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.
    
    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
    
    Since:
    
    5.2
  - decodeBufferPolicy
```
public ClientOptions.Builder decodeBufferPolicy(DecodeBufferPolicy policy)
```
    Set the policy to discard read bytes from the decoding aggregation buffer to reclaim memory.
    
    Parameters:
    
    policy - the policy to use in CommandHandler
    
    Returns:
    
    this
    
    Since:
    
    6.0
    
    See Also:
    
    DecodeBufferPolicies
  - disconnectedBehavior
```
public ClientOptions.Builder disconnectedBehavior(ClientOptions.DisconnectedBehavior disconnectedBehavior)
```
    Sets the behavior for command invocation when connections are in a disconnected state. Defaults to true. See ClientOptions.DEFAULT_DISCONNECTED_BEHAVIOR.
    
    Parameters:
    
    disconnectedBehavior - must not be null.
    
    Returns:
    
    this
  - pingBeforeActivateConnection
```
public ClientOptions.Builder pingBeforeActivateConnection(boolean pingBeforeActivateConnection)
```
    Sets the PING before activate connection flag. Defaults to true. See ClientOptions.DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION. This option has no effect unless forcing to use the RESP 2 protocol version.
    
    Parameters:
    
    pingBeforeActivateConnection - true/false
    
    Returns:
    
    this
  - protocolVersion
```
public ClientOptions.Builder protocolVersion(ProtocolVersion protocolVersion)
```
    Sets the ProtocolVersion to use. Defaults to RESP3. See ClientOptions.DEFAULT_PROTOCOL_VERSION.
    
    Parameters:
    
    protocolVersion - version to use.
    
    Returns:
    
    this
    
    Since:
    
    6.0
    
    See Also:
    
    ProtocolVersion.newestSupported()
  - publishOnScheduler
```
public ClientOptions.Builder publishOnScheduler(boolean publishOnScheduler)
```
    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.
    
    Parameters:
    
    publishOnScheduler - true/false
    
    Returns:
    
    this
    
    Since:
    
    5.2
    
    See Also:
    
    Subscriber.onNext(Object), ClientResources.eventExecutorGroup()
  - requestQueueSize
```
public ClientOptions.Builder requestQueueSize(int requestQueueSize)
```
    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.
    
    Parameters:
    
    requestQueueSize - the queue size.
    
    Returns:
    
    this
  - scriptCharset
```
public ClientOptions.Builder scriptCharset(Charset scriptCharset)
```
    Sets the Lua script Charset to use to encode scripts to byte[]. Defaults to StandardCharsets.UTF_8. See ClientOptions.DEFAULT_SCRIPT_CHARSET.
    
    Parameters:
    
    scriptCharset - must not be null.
    
    Returns:
    
    this
    
    Since:
    
    6.0
  - socketOptions
```
public ClientOptions.Builder socketOptions(SocketOptions socketOptions)
```
    Sets the low-level SocketOptions for the connections kept to Redis servers. See ClientOptions.DEFAULT_SOCKET_OPTIONS.
    
    Parameters:
    
    socketOptions - must not be null.
    
    Returns:
    
    this
  - sslOptions
```
public ClientOptions.Builder sslOptions(SslOptions sslOptions)
```
    Sets the SslOptions for SSL connections kept to Redis servers. See ClientOptions.DEFAULT_SSL_OPTIONS.
    
    Parameters:
    
    sslOptions - must not be null.
    
    Returns:
    
    this
  - suspendReconnectOnProtocolFailure
```
public ClientOptions.Builder suspendReconnectOnProtocolFailure(boolean suspendReconnectOnProtocolFailure)
```
    Suspends reconnect when reconnects run into protocol failures (SSL verification, PING before connect fails). Defaults to false. See ClientOptions.DEFAULT_SUSPEND_RECONNECT_PROTO_FAIL.
    
    Parameters:
    
    suspendReconnectOnProtocolFailure - true/false
    
    Returns:
    
    this
  - timeoutOptions
```
public ClientOptions.Builder timeoutOptions(TimeoutOptions timeoutOptions)
```
    Sets the TimeoutOptions to expire and cancel commands. See ClientOptions.DEFAULT_TIMEOUT_OPTIONS.
    
    Parameters:
    
    timeoutOptions - must not be null.
    
    Returns:
    
    this
    
    Since:
    
    5.1
  - build
```
public ClientOptions build()
```
    Create a new instance of ClientOptions.
    
    Returns:
    
    new instance of ClientOptions

Class ClientOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

autoReconnect

cancelCommandsOnReconnectFailure

bufferUsageRatio

decodeBufferPolicy

disconnectedBehavior

pingBeforeActivateConnection

protocolVersion

publishOnScheduler

requestQueueSize

scriptCharset

socketOptions

sslOptions

suspendReconnectOnProtocolFailure

timeoutOptions

build