HealthStatus enum

The result of a GET /health endpoint call that provides a health-check mechanism for use by load balancers or other network infrastructure. This request will always return a HTTP 200 OK response with a body of "ok", "behind" or "unknown" based on the following conditions:

1. If one or more --known-validator arguments are provided to solana-validator - "ok" is returned when the node has within HEALTH_CHECK_SLOT_DISTANCE slots of the highest known validator, otherwise "behind". "unknown" is returned when no slot information from known validators is not yet available.
2. "ok" is always returned if no known validators are provided.

Inheritance

• Object
• Enum
• HealthStatus

Available extensions

• EnumName

Values

ok → const HealthStatus

The node has within HEALTH_CHECK_SLOT_DISTANCE slots of the highest known validator.

behind → const HealthStatus

The node does not has within HEALTH_CHECK_SLOT_DISTANCE slots of the highest known validator.

unknown → const HealthStatus

No slot information from known validators is currently available.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

tryFromJson(String? json) → HealthStatus?

Creates an instance of this class from the constructor parameters defined in the json object.

Constants

values → const List<HealthStatus>

A constant List of the values in this enum, in order of their declaration.