io.lettuce.core.failover.api

Class MultiDbOptions.Builder

java.lang.Object

io.lettuce.core.failover.api.MultiDbOptions.Builder

Enclosing class:

MultiDbOptions

public static class MultiDbOptions.Builder
extends Object

Builder for MultiDbOptions.

Method Summary

Modifier and Type	Method and Description
MultiDbOptions	build() Builds a new MultiDbOptions instance.
MultiDbOptions.Builder	delayInBetweenFailoverAttempts(Duration delayInBetweenFailoverAttempts) Sets the delay between failover attempts when no healthy database is available.
MultiDbOptions.Builder	failbackCheckInterval(Duration failbackCheckInterval) Sets the interval in milliseconds for checking if failed databases have recovered.
MultiDbOptions.Builder	failbackSupported(boolean failbackSupported) Sets whether automatic failback to higher-priority databases is supported.
MultiDbOptions.Builder	gracePeriod(Duration gracePeriod) Sets the grace period duration that starts when a database is failed over from.
MultiDbOptions.Builder	initializationPolicy(InitializationPolicy initializationPolicy) Sets the initialization policy.

Methods inherited from class java.lang.Object

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

Method Detail

failbackSupported

public MultiDbOptions.Builder failbackSupported(boolean failbackSupported)

Sets whether automatic failback to higher-priority databases is supported.

Parameters:

failbackSupported - true to enable failback

Returns:

this builder

failbackCheckInterval

public MultiDbOptions.Builder failbackCheckInterval(Duration failbackCheckInterval)

Sets the interval in milliseconds for checking if failed databases have recovered.

Parameters:

failbackCheckInterval - the check interval in milliseconds

Returns:

this builder

gracePeriod

public MultiDbOptions.Builder gracePeriod(Duration gracePeriod)

Sets the grace period duration that starts when a database is failed over from. During this grace period, no failbacks or failovers can trigger a switch back to that database until the duration ends.

Defaults to 30 seconds. Set to 0 ms duration to disable grace period.

Parameters:

gracePeriod - the grace period duration in milliseconds

Returns:

this builder

delayInBetweenFailoverAttempts

public MultiDbOptions.Builder delayInBetweenFailoverAttempts(Duration delayInBetweenFailoverAttempts)

Sets the delay between failover attempts when no healthy database is available.

When all databases are unhealthy and no failover target can be selected, the client will wait for this duration before retrying to find a healthy database.

Defaults to 12 seconds.

Parameters:

delayInBetweenFailoverAttempts - the delay between failover attempts

Returns:

this builder

Throws:

IllegalArgumentException - if the delay is zero or negative

initializationPolicy

public MultiDbOptions.Builder initializationPolicy(InitializationPolicy initializationPolicy)

Sets the initialization policy.

Parameters:

initializationPolicy - the initialization policy

Returns:

this builder

build

public MultiDbOptions build()

Builds a new MultiDbOptions instance.

Returns:

a new options instance