io.lettuce.core.failover.api

Class DatabaseConfig

java.lang.Object

io.lettuce.core.failover.api.DatabaseConfig

@Experimental
public class DatabaseConfig
extends Object

Configuration for a database in a multi-database client. Holds the Redis URI, weight for database/endpoint priority, circuit breaker configuration, and optional health check strategy supplier.

Example usage with builder:

 DatabaseConfig config = DatabaseConfig.builder(RedisURI.create("redis://localhost:6379")).weight(1.0f)
         .circuitBreakerConfig(CircuitBreakerConfig.DEFAULT).healthCheckStrategySupplier(PingStrategy.DEFAULT).build();
 

Since:

7.4

Author:

Ali Takavci

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatabaseConfig.Builder Builder for DatabaseConfig.

Method Summary

Modifier and Type	Method and Description
static DatabaseConfig.Builder	builder(RedisURI redisURI) Create a new DatabaseConfig.Builder to construct DatabaseConfig.
boolean	equals(Object o)
CircuitBreakerConfig	getCircuitBreakerConfig() Get the circuit breaker configuration.
ClientOptions	getClientOptions() Get the client options.
HealthCheckStrategySupplier	getHealthCheckStrategySupplier() Get the health check strategy supplier.
RedisURI	getRedisURI() Get the Redis URI.
float	getWeight() Get the weight for database/endpoint priority.
int	hashCode()
DatabaseConfig.Builder	mutate() Create a DatabaseConfig.Builder initialized with this DatabaseConfig's settings.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getRedisURI

public RedisURI getRedisURI()

Get the Redis URI.

Returns:

the Redis URI

getWeight

public float getWeight()

Get the weight for database/endpoint priority.

Returns:

the weight

getClientOptions

public ClientOptions getClientOptions()

Get the client options.

Returns:

the client options

getCircuitBreakerConfig

public CircuitBreakerConfig getCircuitBreakerConfig()

Get the circuit breaker configuration.

Returns:

the circuit breaker configuration

getHealthCheckStrategySupplier

public HealthCheckStrategySupplier getHealthCheckStrategySupplier()

Get the health check strategy supplier.

Returns:

the health check strategy supplier, can be null

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static DatabaseConfig.Builder builder(RedisURI redisURI)

Create a new DatabaseConfig.Builder to construct DatabaseConfig.

Parameters:

redisURI - the Redis URI, must not be null

Returns:

a new DatabaseConfig.Builder

Since:

7.4

mutate

public DatabaseConfig.Builder mutate()

Create a DatabaseConfig.Builder initialized with this DatabaseConfig's settings.

Returns:

a new DatabaseConfig.Builder initialized with this DatabaseConfig's settings

Since:

7.4