Package org.infinispan.health

Enum Class HealthStatus

java.lang.Object

java.lang.Enum<HealthStatus>

org.infinispan.health.HealthStatus

All Implemented Interfaces:

Serializable, Comparable<HealthStatus>, Constable

public enum HealthStatus
extends Enum<HealthStatus>

General Health status.

Since:

9.0

Author:

Sebastian Łaskawiec

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEGRADED	Given entity is unhealthy.
FAILED	The cache did not start due to a error.
HEALTHY	Given entity is healthy.
HEALTHY_REBALANCING	Given entity is healthy but a rebalance is in progress.
INITIALIZING	The given entity is still initializing.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEGRADED

public static final HealthStatus DEGRADED

Given entity is unhealthy.

An unhealthy status means that a cache is in AvailabilityMode.DEGRADED_MODE. Please keep in mind that in the future additional rules might be added to reflect Unhealthy status of the cache.

.

HEALTHY

public static final HealthStatus HEALTHY

Given entity is healthy.

INITIALIZING

public static final HealthStatus INITIALIZING

The given entity is still initializing.

This can happen when the entity does not have the time to completely initialize or when it is recovering after a cluster shutdown.

HEALTHY_REBALANCING

public static final HealthStatus HEALTHY_REBALANCING

Given entity is healthy but a rebalance is in progress.

FAILED

public static final HealthStatus FAILED

The cache did not start due to a error.

Method Details

values

public static HealthStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static HealthStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null