Enum Class HealthCheckStatus

java.lang.Object

java.lang.Enum<HealthCheckStatus>

io.confluent.kafkarest.entities.HealthCheckStatus

All Implemented Interfaces:

Serializable, Comparable<HealthCheckStatus>, Constable

public enum HealthCheckStatus
extends Enum<HealthCheckStatus>

Represents the result of a service health check.

Follows Datadog's convention of reporting 4 different statuses:

• OK (status code 0)
• Warning (status code 1)
• Critical (status code 2)
• Unknown (status code 3)

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
CRITICAL	Indicates that the service might be in a critical condition or down.
OK	Indicates that the service is healthy.
UNKNOWN	Indicates that the health check couldn't determine the health of the service.
WARNING	Indicates that there are some problems with the service.

Method Summary

Modifier and Type	Method	Description
static HealthCheckStatus	fromJson(com.fasterxml.jackson.databind.JsonNode node)
String	getStatus()
int	getStatusCode()
static HealthCheckStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HealthCheckStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OK

public static final HealthCheckStatus OK

Indicates that the service is healthy.

WARNING

public static final HealthCheckStatus WARNING

Indicates that there are some problems with the service.

CRITICAL

public static final HealthCheckStatus CRITICAL

Indicates that the service might be in a critical condition or down.

UNKNOWN

public static final HealthCheckStatus UNKNOWN

Indicates that the health check couldn't determine the health of the service.

Method Details

values

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

getStatus

public String getStatus()

getStatusCode

public int getStatusCode()

fromJson

public static HealthCheckStatus fromJson(com.fasterxml.jackson.databind.JsonNode node)