HealthSupport (Helidon Project 2.6.10 API)

java.lang.Object
- io.helidon.health.HealthSupport

All Implemented Interfaces:

Service
```
public final class HealthSupport
extends Object
implements Service
```
Health check support for integration with webserver, to expose the health endpoint.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class HealthSupport.Builder
Fluent API builder for HealthSupport.

Field Summary

Fields
Modifier and Type Field Description

static String DEFAULT_WEB_CONTEXT
Default web context root of the Health check endpoint.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static HealthSupport.Builder`	`builder()`	Get a builder to configure health support instance.
`static HealthSupport`	`create()`	Create a new HealthSupport with no health checks configured.
`static HealthSupport`	`create(Config config)`	Create a new HealthSupport with no health checks, configured from provided config.
`void`	`update(Routing.Rules rules)`	Updates `Routing.Rules` with `handlers` representing this service.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_WEB_CONTEXT
```
public static final String DEFAULT_WEB_CONTEXT
```
    Default web context root of the Health check endpoint.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - update
```
public void update(Routing.Rules rules)
```
    Description copied from interface: Service
    
    Updates Routing.Rules with handlers representing this service.
    
    Specified by:
    
    update in interface Service
    
    Parameters:
    
    rules - a routing rules to update
  - builder
```
public static HealthSupport.Builder builder()
```
    Get a builder to configure health support instance.
    
    Returns:
    
    fluent API builder
  - create
```
public static HealthSupport create()
```
    Create a new HealthSupport with no health checks configured. The endpoint will always return UP.
    
    Returns:
    
    health support configured with no health checks
  - create
```
public static HealthSupport create(Config config)
```
    Create a new HealthSupport with no health checks, configured from provided config. The endpoint will always return UP.
    
    Parameters:
    
    config - configuration of this health check, used only to get web-context property to configure HealthSupport.Builder.webContext(String)
    
    Returns:
    
    health support configured with no health checks