Module io.helidon.health

Package io.helidon.health

Interface HealthCheckResponse

public interface HealthCheckResponse

Health check response.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HealthCheckResponse.Builder	Fluent API builder for HealthCheckResponse.
static enum	HealthCheckResponse.Status	Health check status.

Method Summary

Modifier and Type	Method	Description
static HealthCheckResponse.Builder	builder()	A new response builder.
Map<String,Object>	details()	Details of this health check.
HealthCheckResponse.Status	status()	Status of this health check.

Method Details

builder

static HealthCheckResponse.Builder builder()

A new response builder.

Returns:

a new builder

status

HealthCheckResponse.Status status()

Status of this health check.

Returns:

status

details

Map<String,Object> details()

Details of this health check. This information will be transferred over the network when details are printed!

Returns:

details of this health check