io.lettuce.core.failover.health

Enum HealthStatus

java.lang.Object

java.lang.Enum<HealthStatus>

io.lettuce.core.failover.health.HealthStatus

All Implemented Interfaces:

Serializable, Comparable<HealthStatus>

@Experimental
public enum HealthStatus
extends Enum<HealthStatus>

Enumeration representing the health status of a database endpoint as determined by the health check service.

This status reflects the results from active health checks performed by the health check service. Health checks periodically probes endpoints to verify their availability and responsiveness, updating this status accordingly.

Used by the RedisDatabaseImpl to track and report health check results from the health check API.

Since:

7.4

Author:

Ali Takavci

Enum Constant Summary

Enum Constants

Enum Constant and Description
HEALTHY The endpoint is healthy and operating normally according to health check probes.
UNHEALTHY The endpoint is unhealthy according to health check probes.
UNKNOWN Health status is unknown.

Method Summary

Modifier and Type	Method and Description
boolean	isHealthy()
static HealthStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static HealthStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final HealthStatus UNKNOWN

Health status is unknown. This is the initial state before any health checks have been performed by the health check service.

HEALTHY

public static final HealthStatus HEALTHY

The endpoint is healthy and operating normally according to health check probes. Health checks are passing and the endpoint is responding as expected.

UNHEALTHY

public static final HealthStatus UNHEALTHY

The endpoint is unhealthy according to health check probes. Health checks are failing, indicating the endpoint is not responding or not meeting health criteria.

Method Detail

values

public static HealthStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HealthStatus c : HealthStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HealthStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isHealthy

public boolean isHealthy()