DefaultJedisClientConfig.Builder (Jedis 8.0.0 API)

java.lang.Object
- redis.clients.jedis.DefaultJedisClientConfig.Builder

Enclosing class:: DefaultJedisClientConfig

public static class DefaultJedisClientConfig.Builder
extends java.lang.Object

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`DefaultJedisClientConfig.Builder`	`authXManager(AuthXManager authXManager)`
`DefaultJedisClientConfig.Builder`	`autoNegotiateProtocol(boolean autoNegotiateProtocol)` When the protocol is left as `null`, controls whether the connection attempts `HELLO 3` with graceful RESP2 fallback (when `true`, the default) or skips `HELLO` altogether (when `false`, the legacy behaviour).
`DefaultJedisClientConfig.Builder`	`blockingSocketTimeoutMillis(int blockingSocketTimeoutMillis)`
`DefaultJedisClientConfig`	`build()`
`DefaultJedisClientConfig.Builder`	`clientName(java.lang.String clientName)`
`DefaultJedisClientConfig.Builder`	`clientSetInfoConfig(ClientSetInfoConfig setInfoConfig)`
`DefaultJedisClientConfig.Builder`	`commandKeyArgumentPreProcessor(CommandKeyArgumentPreProcessor commandKeyArgumentPreProcessor)` Sets a key argument pre-processor applied to every command before it is sent.
`DefaultJedisClientConfig.Builder`	`connectionTimeoutMillis(int connectionTimeoutMillis)`
`DefaultJedisClientConfig.Builder`	`credentials(RedisCredentials credentials)`
`DefaultJedisClientConfig.Builder`	`credentialsProvider(java.util.function.Supplier<RedisCredentials> credentials)`
`DefaultJedisClientConfig.Builder`	`database(int database)`
`DefaultJedisClientConfig.Builder`	`from(JedisClientConfig instance)`
`DefaultJedisClientConfig.Builder`	`hostAndPortMapper(HostAndPortMapper hostAndPortMapper)`
`DefaultJedisClientConfig.Builder`	`hostnameVerifier(javax.net.ssl.HostnameVerifier hostnameVerifier)`
`DefaultJedisClientConfig.Builder`	`jsonObjectMapper(JsonObjectMapper jsonObjectMapper)` Sets a custom JSON object mapper used by RedisJSON commands.
`DefaultJedisClientConfig.Builder`	`password(java.lang.String password)`
`DefaultJedisClientConfig.Builder`	`protocol(RedisProtocol protocol)`
`DefaultJedisClientConfig.Builder`	`readOnlyForRedisClusterReplicas()`
`DefaultJedisClientConfig.Builder`	`resp2()` Shortcut to `protocol(RedisProtocol)` with `RedisProtocol.RESP2`.
`DefaultJedisClientConfig.Builder`	`resp3()` Shortcut to `protocol(RedisProtocol)` with `RedisProtocol.RESP3`.
`DefaultJedisClientConfig.Builder`	`searchDialect(int searchDialect)` Sets the default search dialect for RediSearch commands.
`DefaultJedisClientConfig.Builder`	`serverDefaultProtocol()` Shortcut for the legacy "no HELLO" mode: sets `protocol(null)` and disables auto-negotiation so the connection skips the `HELLO` handshake entirely and assumes RESP2 on the wire.
`DefaultJedisClientConfig.Builder`	`socketTimeoutMillis(int socketTimeoutMillis)`
`DefaultJedisClientConfig.Builder`	`ssl(boolean ssl)` Deprecated. since 7.4.2, use `sslOptions(SslOptions)` instead. For TLS with JVM defaults use `sslOptions(SslOptions.defaults())`.
`DefaultJedisClientConfig.Builder`	`sslOptions(SslOptions sslOptions)` Recommended way to configure TLS/SSL connections.
`DefaultJedisClientConfig.Builder`	`sslParameters(javax.net.ssl.SSLParameters sslParameters)` Deprecated. since 7.4.2, use `sslOptions(SslOptions)` instead.
`DefaultJedisClientConfig.Builder`	`sslSocketFactory(javax.net.ssl.SSLSocketFactory sslSocketFactory)` Deprecated. since 7.4.2, use `sslOptions(SslOptions)` instead.
`DefaultJedisClientConfig.Builder`	`timeoutMillis(int timeoutMillis)`
`DefaultJedisClientConfig.Builder`	`user(java.lang.String user)`

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

- Method Detail
  - build
```
public DefaultJedisClientConfig build()
```
  - resp3
```
public DefaultJedisClientConfig.Builder resp3()
```
    Shortcut to protocol(RedisProtocol) with RedisProtocol.RESP3.
    
    Returns:
    
    this
  - resp2
```
public DefaultJedisClientConfig.Builder resp2()
```
    Shortcut to protocol(RedisProtocol) with RedisProtocol.RESP2.
    
    Returns:
    
    this
  - serverDefaultProtocol
```
public DefaultJedisClientConfig.Builder serverDefaultProtocol()
```
    Shortcut for the legacy "no HELLO" mode: sets protocol(null) and disables auto-negotiation so the connection skips the HELLO handshake entirely and assumes RESP2 on the wire.
    
    Returns:
    
    this
  - protocol
```
public DefaultJedisClientConfig.Builder protocol(RedisProtocol protocol)
```
  - autoNegotiateProtocol
```
public DefaultJedisClientConfig.Builder autoNegotiateProtocol(boolean autoNegotiateProtocol)
```
    When the protocol is left as null, controls whether the connection attempts HELLO 3 with graceful RESP2 fallback (when true, the default) or skips HELLO altogether (when false, the legacy behaviour).
    
    Parameters:
    
    autoNegotiateProtocol - whether to auto-negotiate the protocol on connect
    
    Returns:
    
    this
  - timeoutMillis
```
public DefaultJedisClientConfig.Builder timeoutMillis(int timeoutMillis)
```
  - connectionTimeoutMillis
```
public DefaultJedisClientConfig.Builder connectionTimeoutMillis(int connectionTimeoutMillis)
```
  - socketTimeoutMillis
```
public DefaultJedisClientConfig.Builder socketTimeoutMillis(int socketTimeoutMillis)
```
  - blockingSocketTimeoutMillis
```
public DefaultJedisClientConfig.Builder blockingSocketTimeoutMillis(int blockingSocketTimeoutMillis)
```
  - user
```
public DefaultJedisClientConfig.Builder user(java.lang.String user)
```
  - password
```
public DefaultJedisClientConfig.Builder password(java.lang.String password)
```
  - credentials
```
public DefaultJedisClientConfig.Builder credentials(RedisCredentials credentials)
```
  - credentialsProvider
```
public DefaultJedisClientConfig.Builder credentialsProvider(java.util.function.Supplier<RedisCredentials> credentials)
```
  - database
```
public DefaultJedisClientConfig.Builder database(int database)
```
  - clientName
```
public DefaultJedisClientConfig.Builder clientName(java.lang.String clientName)
```
  - ssl
```
@Deprecated
public DefaultJedisClientConfig.Builder ssl(boolean ssl)
```
    Deprecated. since 7.4.2, use sslOptions(SslOptions) instead. For TLS with JVM defaults use sslOptions(SslOptions.defaults()).
    
    Enable TLS/SSL for connections.
    TLS is enabled when either ssl(true) or sslOptions(SslOptions) is set. sslOptions(SslOptions) takes precedence; otherwise TLS uses sslSocketFactory(SSLSocketFactory) and sslParameters(SSLParameters).
    
    Parameters:
    
    ssl - true to enable TLS/SSL
    
    Returns:
    
    this
  - sslSocketFactory
```
@Deprecated
public DefaultJedisClientConfig.Builder sslSocketFactory(javax.net.ssl.SSLSocketFactory sslSocketFactory)
```
    Deprecated. since 7.4.2, use sslOptions(SslOptions) instead.
  - sslParameters
```
@Deprecated
public DefaultJedisClientConfig.Builder sslParameters(javax.net.ssl.SSLParameters sslParameters)
```
    Deprecated. since 7.4.2, use sslOptions(SslOptions) instead.
  - sslOptions
```
public DefaultJedisClientConfig.Builder sslOptions(SslOptions sslOptions)
```
    Recommended way to configure TLS/SSL connections.
    When set, TLS is enabled and sslSocketFactory(SSLSocketFactory) / sslParameters(SSLParameters) are ignored.
    
    Parameters:
    
    sslOptions - TLS configuration
    
    Returns:
    
    this
    
    See Also:
    
    SslOptions
  - hostnameVerifier
```
public DefaultJedisClientConfig.Builder hostnameVerifier(javax.net.ssl.HostnameVerifier hostnameVerifier)
```
  - hostAndPortMapper
```
public DefaultJedisClientConfig.Builder hostAndPortMapper(HostAndPortMapper hostAndPortMapper)
```
  - clientSetInfoConfig
```
public DefaultJedisClientConfig.Builder clientSetInfoConfig(ClientSetInfoConfig setInfoConfig)
```
  - readOnlyForRedisClusterReplicas
```
public DefaultJedisClientConfig.Builder readOnlyForRedisClusterReplicas()
```
  - authXManager
```
public DefaultJedisClientConfig.Builder authXManager(AuthXManager authXManager)
```
  - commandKeyArgumentPreProcessor
```
public DefaultJedisClientConfig.Builder commandKeyArgumentPreProcessor(CommandKeyArgumentPreProcessor commandKeyArgumentPreProcessor)
```
    Sets a key argument pre-processor applied to every command before it is sent. Useful for implementing key prefixing or other key rewriting strategies.
    Not honored by the legacy Jedis class — only the UnifiedJedis family reads this value when constructing its command pipeline.
    
    Parameters:
    
    commandKeyArgumentPreProcessor - the pre-processor (or null to disable)
    
    Returns:
    
    this
  - jsonObjectMapper
```
public DefaultJedisClientConfig.Builder jsonObjectMapper(JsonObjectMapper jsonObjectMapper)
```
    Sets a custom JSON object mapper used by RedisJSON commands. When unset, the default Gson-based mapper is used.
    Not honored by the legacy Jedis class — only the UnifiedJedis family reads this value when constructing its command pipeline.
    
    Parameters:
    
    jsonObjectMapper - the mapper (or null to fall back to the default)
    
    Returns:
    
    this
  - searchDialect
```
public DefaultJedisClientConfig.Builder searchDialect(int searchDialect)
```
    Sets the default search dialect for RediSearch commands. Defaults to SearchProtocol.DEFAULT_DIALECT.
    Not honored by the legacy Jedis class — only the UnifiedJedis family reads this value when constructing its command pipeline.
    
    Parameters:
    
    searchDialect - the dialect version (must not be 0)
    
    Returns:
    
    this
    
    Throws:
    
    java.lang.IllegalArgumentException - if searchDialect == 0
  - from
```
public DefaultJedisClientConfig.Builder from(JedisClientConfig instance)
```

Class DefaultJedisClientConfig.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

build

resp3

resp2

serverDefaultProtocol

protocol

autoNegotiateProtocol

timeoutMillis

connectionTimeoutMillis

socketTimeoutMillis

blockingSocketTimeoutMillis

user

password

credentials

credentialsProvider

database

clientName

ssl

sslSocketFactory

sslParameters

sslOptions

hostnameVerifier

hostAndPortMapper

clientSetInfoConfig

readOnlyForRedisClusterReplicas

authXManager

commandKeyArgumentPreProcessor

jsonObjectMapper

searchDialect

from