HealthCheckResult class

Result of a single health indicator check.

Follows the draft RFC for Health Check Response Format: https://datatracker.ietf.org/doc/html/draft-inadarei-api-health-check-06

Properties

componentId → String?
Unique identifier for the component instance.
final
componentType → String?
Type of the component, e.g., datastore, system, component.
final
hashCode → int
The hash code for this object.
no setterinherited
isHealthy → bool
Whether this check passed.
no setter
name → String
The name of the indicator that produced this result.
final
observedUnit → String?
Unit of the observed value, e.g., ms, percent, bytes.
final
observedValue → Object?
The observed value from the check.
final
output → String?
Human-readable output message, especially useful for failures.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status → HealthStatus
Whether the check passed or failed.
final
time → DateTime
Timestamp when this check was performed.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Converts this result to a JSON map following the RFC format.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited