Class CompositeHealthDescriptor

java.lang.Object

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

org.springframework.boot.health.actuate.endpoint.CompositeHealthDescriptor

All Implemented Interfaces:

OperationResponseBody

Direct Known Subclasses:

SystemHealthDescriptor

public sealed class CompositeHealthDescriptor
extends HealthDescriptor
permits SystemHealthDescriptor

Description of health that is composed of other health descriptors.

Since:

4.0.0

Author:

Phillip Webb

Method Summary

Modifier and Type	Method	Description
@Nullable Map<String, HealthDescriptor>	getComponents()
@Nullable Map<String, HealthDescriptor>	getDetails()
Status	getStatus()	Return the status of the component.

Methods inherited from class Object

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

Method Details

getStatus

public Status getStatus()

Description copied from class: HealthDescriptor

Return the status of the component.

Specified by:

getStatus in class HealthDescriptor

Returns:

the component status

getComponents

public @Nullable Map<String, HealthDescriptor> getComponents()

getDetails

public @Nullable Map<String, HealthDescriptor> getDetails()