Module io.helidon.health

Package io.helidon.health

Enum Class HealthCheckType

java.lang.Object

java.lang.Enum<HealthCheckType>

io.helidon.health.HealthCheckType

All Implemented Interfaces:

Serializable, Comparable<HealthCheckType>, Constable

public enum HealthCheckType
extends Enum<HealthCheckType>

Possible types of health checks.

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	Liveness health check.
READINESS	Readiness health check.
STARTUP	Startup health check.

Method Summary

Modifier and Type	Method	Description
String	defaultEndpoint()	Default endpoint of a health check type, relative to the root of health checks (such as ready for readiness, so full path by default would be /observe/health/ready).
static HealthCheckType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HealthCheckType[]	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

READINESS

public static final HealthCheckType READINESS

Readiness health check. Indicates that the server is ready to serve requests.

LIVENESS

public static final HealthCheckType LIVENESS

Liveness health check. Indicates that the server is still up and running.

STARTUP

public static final HealthCheckType STARTUP

Startup health check. Indicates that mandatory start operation has been executed.

Method Details

values

public static HealthCheckType[] 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 HealthCheckType 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

defaultEndpoint

public String defaultEndpoint()

Default endpoint of a health check type, relative to the root of health checks (such as ready for readiness, so full path by default would be /observe/health/ready).

Returns:

default endpoint