Class HealthDescriptor

java.lang.Object

org.springframework.boot.health.actuate.endpoint.HealthDescriptor

All Implemented Interfaces:

org.springframework.boot.actuate.endpoint.OperationResponseBody

Direct Known Subclasses:

CompositeHealthDescriptor, IndicatedHealthDescriptor

public abstract sealed class HealthDescriptor
extends Object
implements org.springframework.boot.actuate.endpoint.OperationResponseBody
permits IndicatedHealthDescriptor, CompositeHealthDescriptor

Description of health including a status.

Since:

4.0.0

Constructor Summary

Constructors

Constructor	Description
HealthDescriptor()

Method Summary

Modifier and Type	Method	Description
abstract Status	getStatus()	Return the status of the component.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HealthDescriptor

public HealthDescriptor()

Method Details

getStatus

public abstract Status getStatus()

Return the status of the component.

Returns:

the component status