Package io.smallrye.health.api

Enum HealthType

java.lang.Object

java.lang.Enum<HealthType>

io.smallrye.health.api.HealthType

All Implemented Interfaces:

Serializable, Comparable<HealthType>, java.lang.constant.Constable

public enum HealthType
extends Enum<HealthType>

The default types of health representing out-of-the-box health check groups.

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
LIVENESS
READINESS
STARTUP
WELLNESS

Method Summary

Modifier and Type	Method	Description
static HealthType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static HealthType[]	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, 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

LIVENESS

public static final HealthType LIVENESS

READINESS

public static final HealthType READINESS

WELLNESS

public static final HealthType WELLNESS

STARTUP

public static final HealthType STARTUP

Method Details

values

public static HealthType[] values()

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

Returns:

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

valueOf

public static HealthType 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