Skip navigation links
B C D G H I L N O R S U V W 

B

build() - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
Creates a HealthCheckResponse from the current builder.
builder() - Static method in class org.eclipse.microprofile.health.HealthCheckResponse
Creates an empty HealthCheckResponseBuilder.

C

call() - Method in interface org.eclipse.microprofile.health.HealthCheck
Invokes the health check procedure provided by the implementation of this interface.
createResponseBuilder() - Method in interface org.eclipse.microprofile.health.spi.HealthCheckResponseProvider
Provides an implementation of HealthCheckResponseBuilder.

D

down(String) - Static method in class org.eclipse.microprofile.health.HealthCheckResponse
Creates a failed health check with a name.
down() - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
Sets the status of the health check response to HealthCheckResponse.State.DOWN.

G

getData() - Method in class org.eclipse.microprofile.health.HealthCheckResponse
 
getName() - Method in class org.eclipse.microprofile.health.HealthCheckResponse
 
getState() - Method in class org.eclipse.microprofile.health.HealthCheckResponse
 

H

Health - Annotation Type in org.eclipse.microprofile.health
Deprecated.
in version 2.0 of the spec.
HealthCheck - Interface in org.eclipse.microprofile.health
The health check procedure interface.
HealthCheckResponse - Class in org.eclipse.microprofile.health
The response to a health check invocation.
HealthCheckResponse(String, HealthCheckResponse.State, Optional<Map<String, Object>>) - Constructor for class org.eclipse.microprofile.health.HealthCheckResponse
Constructor allowing instantiation from 3rd party framework like MicroProfile Rest client
HealthCheckResponse() - Constructor for class org.eclipse.microprofile.health.HealthCheckResponse
Default constructor
HealthCheckResponse.State - Enum in org.eclipse.microprofile.health
 
HealthCheckResponseBuilder - Class in org.eclipse.microprofile.health
A builder to construct a health check procedure response.
HealthCheckResponseBuilder() - Constructor for class org.eclipse.microprofile.health.HealthCheckResponseBuilder
 
HealthCheckResponseProvider - Interface in org.eclipse.microprofile.health.spi
Reserved for implementors as means to supply their own HealthCheckResponseBuilder.

I

INSTANCE - Static variable in class org.eclipse.microprofile.health.Liveness.Literal
 
INSTANCE - Static variable in class org.eclipse.microprofile.health.Readiness.Literal
 

L

Literal() - Constructor for class org.eclipse.microprofile.health.Liveness.Literal
 
Literal() - Constructor for class org.eclipse.microprofile.health.Readiness.Literal
 
Liveness - Annotation Type in org.eclipse.microprofile.health
This qualifier is used to define a liveness Health Check procedure
Liveness.Literal - Class in org.eclipse.microprofile.health
Support inline instantiation of the Liveness qualifier.

N

name(String) - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
Sets the name of the health check response.
named(String) - Static method in class org.eclipse.microprofile.health.HealthCheckResponse
Creates a HealthCheckResponseBuilder with a name.

O

org.eclipse.microprofile.health - package org.eclipse.microprofile.health
Microprofile Health
org.eclipse.microprofile.health.spi - package org.eclipse.microprofile.health.spi
Microprofile Service Health Checks

R

Readiness - Annotation Type in org.eclipse.microprofile.health
This qualifier is used to define a readiness Health Check procedure
Readiness.Literal - Class in org.eclipse.microprofile.health
Support inline instantiation of the Readiness qualifier.

S

setResponseProvider(HealthCheckResponseProvider) - Static method in class org.eclipse.microprofile.health.HealthCheckResponse
Used by OSGi environment where the service loader pattern is not supported.
state(boolean) - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
Sets the status of the health check response according to the boolean value up.

U

up(String) - Static method in class org.eclipse.microprofile.health.HealthCheckResponse
Creates a successful health check with a name.
up() - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
Sets the status of the health check response to HealthCheckResponse.State.UP.

V

valueOf(String) - Static method in enum org.eclipse.microprofile.health.HealthCheckResponse.State
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.eclipse.microprofile.health.HealthCheckResponse.State
Returns an array containing the constants of this enum type, in the order they are declared.

W

withData(String, String) - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
Adds additional string data to the health check response.
withData(String, long) - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
Adds additional numeric data to the health check response.
withData(String, boolean) - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
Adds additional boolean data to the health check response.
B C D G H I L N O R S U V W 
Skip navigation links

Copyright © 2020 Eclipse Foundation. All rights reserved.