io.micronaut.management.health.indicator

Interface HealthResult

public interface HealthResult

Used to represent the output of a HealthIndicator.

Since:

1.0

Author:

James Kleeh

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HealthResult.Builder Helper class to build instances.

Method Summary

Modifier and Type	Method and Description
static HealthResult.Builder	builder(java.lang.String name) Creates a builder to build a HealthResult.
static HealthResult.Builder	builder(java.lang.String name, HealthStatus status) Creates a builder to build a HealthResult.
java.lang.Object	getDetails()
java.lang.String	getName()
HealthStatus	getStatus()

Method Detail

getName

java.lang.String getName()

Returns:

The name associated with the details

getStatus

HealthStatus getStatus()

Returns:

The status of the result

getDetails

java.lang.Object getDetails()

Returns:

Any data to be returned

builder

static HealthResult.Builder builder(java.lang.String name,
                                    HealthStatus status)

Creates a builder to build a HealthResult.

Parameters:

name - The name of the result

status - The status

Returns:

The builder

builder

static HealthResult.Builder builder(java.lang.String name)

Creates a builder to build a HealthResult.

Parameters:

name - The name of the result

Returns:

The builder