Class HealthCheckResponse.Builder

java.lang.Object

io.helidon.health.HealthCheckResponse.Builder

All Implemented Interfaces:

Builder<HealthCheckResponse.Builder, HealthCheckResponse>, Supplier<HealthCheckResponse>

Enclosing interface:

HealthCheckResponse

public static class HealthCheckResponse.Builder
extends Object
implements Builder<HealthCheckResponse.Builder, HealthCheckResponse>

Fluent API builder for HealthCheckResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()	Deprecated, for removal: This API element is subject to removal in a future version. use HealthCheckResponse.builder() instead

Method Summary

Modifier and Type	Method	Description
HealthCheckResponse	build()	Build the instance from this builder.
HealthCheckResponse.Builder	detail(String name, Object value)	Add a detail of this health check, used when details are enabled.
HealthCheckResponse.Builder	status(boolean status)	Status of health check, defaults to HealthCheckResponse.Status.UP.
HealthCheckResponse.Builder	status(HealthCheckResponse.Status status)	Status of health check, defaults to HealthCheckResponse.Status.UP.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default HealthCheckResponse	get()
default HealthCheckResponse.Builder	identity()	Instance of this builder as the correct type.
default HealthCheckResponse.Builder	update(Consumer<HealthCheckResponse.Builder> consumer)	Update the builder in a fluent API way.

Constructor Details

Builder

@Deprecated(forRemoval=true,
            since="27.0.0")
public Builder()

Deprecated, for removal: This API element is subject to removal in a future version.

use HealthCheckResponse.builder() instead

Create a new builder.

Method Details

build

public HealthCheckResponse build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<HealthCheckResponse.Builder, HealthCheckResponse>

Returns:

instance of the built type

status

public HealthCheckResponse.Builder status(HealthCheckResponse.Status status)

Status of health check, defaults to HealthCheckResponse.Status.UP.

Parameters:

status - status

Returns:

updated builder

status

public HealthCheckResponse.Builder status(boolean status)

Status of health check, defaults to HealthCheckResponse.Status.UP.

Parameters:

status - status as a boolean (true for HealthCheckResponse.Status.UP), (false for HealthCheckResponse.Status.DOWN)

Returns:

updated builder

detail

public HealthCheckResponse.Builder detail(String name,
 Object value)

Add a detail of this health check, used when details are enabled.

Parameters:

name - name of the detail

value - value of the detail

Returns:

updated builder