Package org.eclipse.microprofile.health
Class HealthCheckResponse
- java.lang.Object
-
- org.eclipse.microprofile.health.HealthCheckResponse
-
public abstract class HealthCheckResponse extends java.lang.Object
The response to a health check invocation.The HealthCheckResponse class is reserved for an extension by implementation providers. An application should use one of the static methods to create a Response instance using a HealthCheckResponseBuilder.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
HealthCheckResponse.State
-
Constructor Summary
Constructors Constructor Description HealthCheckResponse()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static HealthCheckResponseBuilder
builder()
abstract java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>>
getData()
abstract java.lang.String
getName()
abstract HealthCheckResponse.State
getState()
static HealthCheckResponseBuilder
named(java.lang.String name)
static void
setResponseProvider(HealthCheckResponseProvider provider)
Used by OSGi environment while service loader pattern is not supported.
-
-
-
Method Detail
-
setResponseProvider
public static void setResponseProvider(HealthCheckResponseProvider provider)
Used by OSGi environment while service loader pattern is not supported.- Parameters:
provider
- the provider instance to use.
-
named
public static HealthCheckResponseBuilder named(java.lang.String name)
-
builder
public static HealthCheckResponseBuilder builder()
-
getName
public abstract java.lang.String getName()
-
getState
public abstract HealthCheckResponse.State getState()
-
getData
public abstract java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> getData()
-
-