SystemHealthDescriptor class final
The health of the whole application, the root of /actuator/health:
a composite that also lists the names of the health groups.
Spring Boot (Java): SystemHealthDescriptor (Spring Boot 4;
SystemHealth before).
- Inheritance
-
- Object
- HealthDescriptor
- CompositeHealthDescriptor
- SystemHealthDescriptor
Constructors
-
SystemHealthDescriptor(Status status, Map<
String, HealthDescriptor> ? components, {List<String> groups = const [], ApiVersion apiVersion = ApiVersion.latest}) -
The application's health of
statuswithcomponentsand thegroups' names.
Properties
- apiVersion → ApiVersion
-
The JSON version: version 2 writes the parts under
details.finalinherited -
components
→ Map<
String, HealthDescriptor> ? -
The parts by name, sorted by name (as Spring Boot's
TreeMap);nullwhen hidden (show-components=never).finalinherited -
groups
→ List<
String> -
The names of the health groups, sorted; not written when empty.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status → Status
-
The status of this node.
finalinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
statusJson(
) → Map< String, Object?> -
The status as JSON:
status, anddescriptionwhen there is one.inherited -
toJson(
) → Map< String, Object?> -
The value as JSON: maps, lists, strings, numbers, booleans,
null.override -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited