Class LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder
java.lang.Object
org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration.LettuceClientConfigurationBuilder
org.springframework.data.redis.connection.lettuce.LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder
- Enclosing interface:
- LettucePoolingClientConfiguration
public static class LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder
extends LettuceClientConfiguration.LettuceClientConfigurationBuilder
- Author:
- Mark Paluch, Christoph Strobl, Longlong Zhao
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Build theLettuceClientConfiguration
with the configuration applied from this builder.clientName
(String clientName) Configure aclientName
to be set withCLIENT SETNAME
.clientOptions
(io.lettuce.core.ClientOptions clientOptions) ConfigureClientOptions
.clientResources
(io.lettuce.core.resource.ClientResources clientResources) ConfigureClientResources
.commandTimeout
(Duration timeout) Configure a command timeout.poolConfig
(org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig) Set theGenericObjectPoolConfig
used by the driver.readFrom
(io.lettuce.core.ReadFrom readFrom) ConfigureReadFrom
.redisCredentialsProviderFactory
(RedisCredentialsProviderFactory redisCredentialsProviderFactory) Configure aRedisCredentialsProviderFactory
to obtainRedisCredentialsProvider
instances to support credential rotation.shutdownQuietPeriod
(Duration shutdownQuietPeriod) Configure the shutdown quiet period.shutdownTimeout
(Duration shutdownTimeout) Configure a shutdown timeout.useSsl()
Enable SSL connections.Methods inherited from class org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration.LettuceClientConfigurationBuilder
apply
-
Method Details
-
useSsl
Description copied from class:LettuceClientConfiguration.LettuceClientConfigurationBuilder
Enable SSL connections. -
clientResources
public LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder clientResources(io.lettuce.core.resource.ClientResources clientResources) Description copied from class:LettuceClientConfiguration.LettuceClientConfigurationBuilder
ConfigureClientResources
.- Overrides:
clientResources
in classLettuceClientConfiguration.LettuceClientConfigurationBuilder
- Parameters:
clientResources
- must not be null.- Returns:
- this builder.
-
clientOptions
public LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder clientOptions(io.lettuce.core.ClientOptions clientOptions) Description copied from class:LettuceClientConfiguration.LettuceClientConfigurationBuilder
ConfigureClientOptions
.- Overrides:
clientOptions
in classLettuceClientConfiguration.LettuceClientConfigurationBuilder
- Parameters:
clientOptions
- must not be null.- Returns:
- this builder.
-
commandTimeout
public LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder commandTimeout(Duration timeout) Description copied from class:LettuceClientConfiguration.LettuceClientConfigurationBuilder
Configure a command timeout.- Overrides:
commandTimeout
in classLettuceClientConfiguration.LettuceClientConfigurationBuilder
- Parameters:
timeout
- must not be null.- Returns:
- this builder.
-
shutdownTimeout
public LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder shutdownTimeout(Duration shutdownTimeout) Description copied from class:LettuceClientConfiguration.LettuceClientConfigurationBuilder
Configure a shutdown timeout.- Overrides:
shutdownTimeout
in classLettuceClientConfiguration.LettuceClientConfigurationBuilder
- Parameters:
shutdownTimeout
- must not be null.- Returns:
- this builder.
-
shutdownQuietPeriod
public LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder shutdownQuietPeriod(Duration shutdownQuietPeriod) Description copied from class:LettuceClientConfiguration.LettuceClientConfigurationBuilder
Configure the shutdown quiet period.- Overrides:
shutdownQuietPeriod
in classLettuceClientConfiguration.LettuceClientConfigurationBuilder
- Parameters:
shutdownQuietPeriod
- must not be null.- Returns:
- this builder.
-
readFrom
public LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder readFrom(io.lettuce.core.ReadFrom readFrom) Description copied from class:LettuceClientConfiguration.LettuceClientConfigurationBuilder
ConfigureReadFrom
. Enables Master/Replica operations if configured.- Overrides:
readFrom
in classLettuceClientConfiguration.LettuceClientConfigurationBuilder
- Parameters:
readFrom
- must not be null.- Returns:
- this builder.
-
redisCredentialsProviderFactory
public LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder redisCredentialsProviderFactory(RedisCredentialsProviderFactory redisCredentialsProviderFactory) Description copied from class:LettuceClientConfiguration.LettuceClientConfigurationBuilder
Configure aRedisCredentialsProviderFactory
to obtainRedisCredentialsProvider
instances to support credential rotation.- Overrides:
redisCredentialsProviderFactory
in classLettuceClientConfiguration.LettuceClientConfigurationBuilder
- Parameters:
redisCredentialsProviderFactory
- must not be null.- Returns:
- this builder.
-
clientName
public LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder clientName(String clientName) Description copied from class:LettuceClientConfiguration.LettuceClientConfigurationBuilder
Configure aclientName
to be set withCLIENT SETNAME
.- Overrides:
clientName
in classLettuceClientConfiguration.LettuceClientConfigurationBuilder
- Parameters:
clientName
- must not be null or empty.- Returns:
- this builder.
-
poolConfig
public LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder poolConfig(org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig) Set theGenericObjectPoolConfig
used by the driver.- Parameters:
poolConfig
- must not be null.
-
build
Description copied from class:LettuceClientConfiguration.LettuceClientConfigurationBuilder
Build theLettuceClientConfiguration
with the configuration applied from this builder.- Overrides:
build
in classLettuceClientConfiguration.LettuceClientConfigurationBuilder
- Returns:
- a new
LettuceClientConfiguration
object.
-