Interface HealthResult
-
public interface HealthResultUsed to represent the output of a
HealthIndicator.- Since:
- 1.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classHealthResult.BuilderHelper class to build instances.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static HealthResult.Builderbuilder(java.lang.String name)Creates a builder to build aHealthResult.static HealthResult.Builderbuilder(java.lang.String name, io.micronaut.health.HealthStatus status)Creates a builder to build aHealthResult.java.lang.ObjectgetDetails()java.lang.StringgetName()io.micronaut.health.HealthStatusgetStatus()
-
-
-
Method Detail
-
getName
java.lang.String getName()
- Returns:
- The name associated with the details
-
getStatus
io.micronaut.health.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, io.micronaut.health.HealthStatus status)
Creates a builder to build aHealthResult.- Parameters:
name- The name of the resultstatus- The status- Returns:
- The builder
-
builder
static HealthResult.Builder builder(java.lang.String name)
Creates a builder to build aHealthResult.- Parameters:
name- The name of the result- Returns:
- The builder
-
-