io.lettuce.core.failover.health

Class LagAwareStrategy.Config

java.lang.Object

io.lettuce.core.failover.health.HealthCheckStrategy.Config

io.lettuce.core.failover.health.LagAwareStrategy.Config

Enclosing class:

LagAwareStrategy

public static class LagAwareStrategy.Config
extends HealthCheckStrategy.Config

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LagAwareStrategy.Config.Builder Builder for LagAwareStrategy.Config.

Field Summary

Fields

Modifier and Type	Field and Description
static Duration	AVAILABILITY_LAG_TOLERANCE_DEFAULT
static boolean	EXTENDED_CHECK_DEFAULT

Fields inherited from class io.lettuce.core.failover.health.HealthCheckStrategy.Config

delayInBetweenProbes, interval, numProbes, policy, timeout

Constructor Summary

Constructors

Constructor and Description
Config(URI restEndpoint, Supplier<RedisCredentials> credentialsSupplier)

Method Summary

Modifier and Type	Method and Description
static LagAwareStrategy.Config.Builder	builder() Use builder(URI, Supplier) instead.
static LagAwareStrategy.Config.Builder	builder(URI restEndpoint, Supplier<RedisCredentials> credentialsSupplier) Create a new builder for LagAwareStrategy.Config.
static LagAwareStrategy.Config	create(URI restEndpoint, Supplier<RedisCredentials> credentialsSupplier) Create a new Config instance with default values.
static LagAwareStrategy.Config	databaseAvailability(URI restEndpoint, Supplier<RedisCredentials> credentialsSupplier) Perform standard datapath validation only.
Duration	getAvailabilityLagTolerance()
Supplier<RedisCredentials>	getCredentialsSupplier()
URI	getRestEndpoint()
SslOptions	getSslOptions()
boolean	isExtendedCheckEnabled()
static LagAwareStrategy.Config	lagAware(URI restEndpoint, Supplier<RedisCredentials> credentialsSupplier) Perform standard datapath validation and lag validation using the default lag tolerance.
static LagAwareStrategy.Config	lagAwareWithTolerance(URI restEndpoint, Supplier<RedisCredentials> credentialsSupplier, Duration availabilityLagTolerance) Perform standard datapath validation and lag validation using the specified lag tolerance.

Methods inherited from class io.lettuce.core.failover.health.HealthCheckStrategy.Config

create, getDelayInBetweenProbes, getInterval, getNumProbes, getPolicy, getTimeout

Methods inherited from class java.lang.Object

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

Field Detail

EXTENDED_CHECK_DEFAULT

public static final boolean EXTENDED_CHECK_DEFAULT

See Also:

Constant Field Values

AVAILABILITY_LAG_TOLERANCE_DEFAULT

public static final Duration AVAILABILITY_LAG_TOLERANCE_DEFAULT

Constructor Detail

Config

public Config(URI restEndpoint,
              Supplier<RedisCredentials> credentialsSupplier)

Method Detail

getRestEndpoint

public URI getRestEndpoint()

getCredentialsSupplier

public Supplier<RedisCredentials> getCredentialsSupplier()

getSslOptions

public SslOptions getSslOptions()

getAvailabilityLagTolerance

public Duration getAvailabilityLagTolerance()

isExtendedCheckEnabled

public boolean isExtendedCheckEnabled()

builder

public static LagAwareStrategy.Config.Builder builder(URI restEndpoint,
                                                      Supplier<RedisCredentials> credentialsSupplier)

Create a new builder for LagAwareStrategy.Config.

Parameters:

restEndpoint - the Redis Enterprise REST API endpoint

credentialsSupplier - the credentials supplier

Returns:

a new ConfigBuilder instance

builder

public static LagAwareStrategy.Config.Builder builder()

Use builder(URI, Supplier) instead.

Returns:

a new Builder instance

create

public static LagAwareStrategy.Config create(URI restEndpoint,
                                             Supplier<RedisCredentials> credentialsSupplier)

Create a new Config instance with default values.

Extended checks like lag validation is enabled by default. With a default lag tolerance of 100ms. To perform only standard datapath validation, use databaseAvailability(URI, Supplier). To configure a custom lag tolerance, use lagAwareWithTolerance(URI, Supplier, Duration)

databaseAvailability

public static LagAwareStrategy.Config databaseAvailability(URI restEndpoint,
                                                           Supplier<RedisCredentials> credentialsSupplier)

Perform standard datapath validation only.

Extended checks like lag validation is disabled by default. To enable extended checks, use lagAware(URI, Supplier) or lagAwareWithTolerance(URI, Supplier, Duration)

lagAware

public static LagAwareStrategy.Config lagAware(URI restEndpoint,
                                               Supplier<RedisCredentials> credentialsSupplier)

Perform standard datapath validation and lag validation using the default lag tolerance.

To configure a custom lag tolerance, use lagAwareWithTolerance(URI, Supplier, Duration)

lagAwareWithTolerance

public static LagAwareStrategy.Config lagAwareWithTolerance(URI restEndpoint,
                                                            Supplier<RedisCredentials> credentialsSupplier,
                                                            Duration availabilityLagTolerance)

Perform standard datapath validation and lag validation using the specified lag tolerance.