HealthCheckResponse

java.lang.Object
- org.eclipse.microprofile.health.HealthCheckResponse

```
public 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. When used on the consuming end, The class can also be instantiated directly.

Examples (en):

mp-custom-healthcheck

Examples (es):

mp-custom-healthcheck

Examples (pt):

mp-custom-healthcheck

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HealthCheckResponse.Status

Nested Classes
Modifier and Type	Class and Description
`static class`	`HealthCheckResponse.Status`

Constructor Summary

Constructors
Constructor and Description
`HealthCheckResponse()` Default constructor
`HealthCheckResponse(java.lang.String name, HealthCheckResponse.Status status, java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> data)` Constructor allowing instantiation from 3rd party framework like MicroProfile Rest client

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static HealthCheckResponseBuilder`	`builder()` Creates an empty `HealthCheckResponseBuilder`.
`static HealthCheckResponse`	`down(java.lang.String name)` Creates a failed health check with a name.
`java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>>`	`getData()`
`java.lang.String`	`getName()`
`HealthCheckResponse.Status`	`getStatus()`
`static HealthCheckResponseBuilder`	`named(java.lang.String name)` Creates a `HealthCheckResponseBuilder` with a name.
`static void`	`setResponseProvider(HealthCheckResponseProvider provider)` Used by OSGi environment where the service loader pattern is not supported.
`static HealthCheckResponse`	`up(java.lang.String name)` Creates a successful health check with a name.

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

- Constructor Detail
  - HealthCheckResponse
```
public HealthCheckResponse(java.lang.String name,
                           HealthCheckResponse.Status status,
                           java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> data)
```
    Constructor allowing instantiation from 3rd party framework like MicroProfile Rest client
    
    Parameters:
    
    name - Health Check procedure's name
    
    status - Health Check procedure's status
    
    data - additional data for Health Check procedure
  - HealthCheckResponse
```
public HealthCheckResponse()
```
    Default constructor
- Method Detail
  - setResponseProvider
```
public static void setResponseProvider(HealthCheckResponseProvider provider)
```
    Used by OSGi environment where the service loader pattern is not supported.
    
    Parameters:
    
    provider - the provider instance to use.
  - named
```
public static HealthCheckResponseBuilder named(java.lang.String name)
```
    Creates a HealthCheckResponseBuilder with a name.
    
    Parameters:
    
    name - the check name
    
    Returns:
    
    a new health check builder with a name
  - builder
```
public static HealthCheckResponseBuilder builder()
```
    Creates an empty HealthCheckResponseBuilder. Note: The health check response name is required and needs to be set before the response is constructed.
    
    Returns:
    
    a new, empty health check builder
  - up
```
public static HealthCheckResponse up(java.lang.String name)
```
    Creates a successful health check with a name.
    
    Parameters:
    
    name - the check name
    
    Returns:
    
    a new sucessful health check response with a name
  - down
```
public static HealthCheckResponse down(java.lang.String name)
```
    Creates a failed health check with a name.
    
    Parameters:
    
    name - the check name
    
    Returns:
    
    a new failed health check response with a name
  - getName
```
public java.lang.String getName()
```
  - getStatus
```
public HealthCheckResponse.Status getStatus()
```
  - getData
```
public java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> getData()
```

Class HealthCheckResponse

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HealthCheckResponse

HealthCheckResponse

Method Detail

setResponseProvider

named

builder

up

down

getName

getStatus

getData