Package org.springframework.data.redis.connection.lettuce

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 Type	Method	Description
LettucePoolingClientConfiguration	build()	Build the LettuceClientConfiguration with the configuration applied from this builder.
LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder	clientName(String clientName)	Configure a clientName to be set with CLIENT SETNAME.
LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder	clientOptions(io.lettuce.core.ClientOptions clientOptions)	Configure ClientOptions.
LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder	clientResources(io.lettuce.core.resource.ClientResources clientResources)	Configure ClientResources.
LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder	commandTimeout(Duration timeout)	Configure a command timeout.
LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder	poolConfig(org.apache.commons.pool2.impl.GenericObjectPoolConfig poolConfig)	Set the GenericObjectPoolConfig used by the driver.
LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder	readFrom(io.lettuce.core.ReadFrom readFrom)	Configure ReadFrom.
LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder	redisCredentialsProviderFactory(RedisCredentialsProviderFactory redisCredentialsProviderFactory)	Configure a RedisCredentialsProviderFactory to obtain RedisCredentialsProvider instances to support credential rotation.
LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder	shutdownQuietPeriod(Duration shutdownQuietPeriod)	Configure the shutdown quiet period.
LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder	shutdownTimeout(Duration shutdownTimeout)	Configure a shutdown timeout.
LettucePoolingClientConfiguration.LettucePoolingSslClientConfigurationBuilder	useSsl()	Enable SSL connections.

Methods inherited from class org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration.LettuceClientConfigurationBuilder

apply

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

useSsl

public LettucePoolingClientConfiguration.LettucePoolingSslClientConfigurationBuilder useSsl()

Description copied from class: LettuceClientConfiguration.LettuceClientConfigurationBuilder

Enable SSL connections.

Overrides:

useSsl in class LettuceClientConfiguration.LettuceClientConfigurationBuilder

Returns:

LettuceClientConfiguration.LettuceSslClientConfigurationBuilder.

clientResources

public LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder clientResources(io.lettuce.core.resource.ClientResources clientResources)

Description copied from class: LettuceClientConfiguration.LettuceClientConfigurationBuilder

Configure ClientResources.

Overrides:

clientResources in class LettuceClientConfiguration.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

Configure ClientOptions.

Overrides:

clientOptions in class LettuceClientConfiguration.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 class LettuceClientConfiguration.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 class LettuceClientConfiguration.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 class LettuceClientConfiguration.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

Configure ReadFrom. Enables Master/Replica operations if configured.

Overrides:

readFrom in class LettuceClientConfiguration.LettuceClientConfigurationBuilder

Parameters:

readFrom - must not be null.

Returns:

this builder.

redisCredentialsProviderFactory

public LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder redisCredentialsProviderFactory(RedisCredentialsProviderFactory redisCredentialsProviderFactory)

Description copied from class: LettuceClientConfiguration.LettuceClientConfigurationBuilder

Configure a RedisCredentialsProviderFactory to obtain RedisCredentialsProvider instances to support credential rotation.

Overrides:

redisCredentialsProviderFactory in class LettuceClientConfiguration.LettuceClientConfigurationBuilder

Parameters:

redisCredentialsProviderFactory - must not be null.

Returns:

this builder.

clientName

public LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder clientName(String clientName)

Description copied from class: LettuceClientConfiguration.LettuceClientConfigurationBuilder

Configure a clientName to be set with CLIENT SETNAME.

Overrides:

clientName in class LettuceClientConfiguration.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 the GenericObjectPoolConfig used by the driver.

Parameters:

poolConfig - must not be null.

build

public LettucePoolingClientConfiguration build()

Description copied from class: LettuceClientConfiguration.LettuceClientConfigurationBuilder

Build the LettuceClientConfiguration with the configuration applied from this builder.

Overrides:

build in class LettuceClientConfiguration.LettuceClientConfigurationBuilder

Returns:

a new LettuceClientConfiguration object.