public static class HealthCheck.ResultBuilder extends Object
HealthCheck.Result
. It can be health (with optional message and detail)
or unhealthy (with optional message, error and detail)Modifier | Constructor and Description |
---|---|
protected |
ResultBuilder() |
Modifier and Type | Method and Description |
---|---|
HealthCheck.Result |
build() |
HealthCheck.ResultBuilder |
healthy()
Configure an healthy result
|
HealthCheck.ResultBuilder |
unhealthy()
Configure an unhealthy result
|
HealthCheck.ResultBuilder |
unhealthy(Throwable error)
Configure an unhealthy result with an
error |
HealthCheck.ResultBuilder |
withDetail(String key,
Object data)
Add an optional detail
|
HealthCheck.ResultBuilder |
withMessage(String message)
Set an optional message
|
HealthCheck.ResultBuilder |
withMessage(String message,
Object... args)
Set an optional formatted message
Message formatting follows the same rules as
String.format(String, Object...) . |
public HealthCheck.ResultBuilder healthy()
public HealthCheck.ResultBuilder unhealthy()
public HealthCheck.ResultBuilder unhealthy(Throwable error)
error
error
- the errorpublic HealthCheck.ResultBuilder withMessage(String message)
message
- an informative messagemessage
public HealthCheck.ResultBuilder withMessage(String message, Object... args)
String.format(String, Object...)
.message
- a message formatargs
- the arguments apply to the message formatmessage
String.format(String, Object...)
public HealthCheck.ResultBuilder withDetail(String key, Object data)
key
- a key for this detaildata
- an object representing the detail datapublic HealthCheck.Result build()
Copyright © 2020. All Rights Reserved.