Class HeapMemoryHealthCheck.Builder

java.lang.Object

io.helidon.health.checks.HeapMemoryHealthCheck.Builder

All Implemented Interfaces:

Builder<HeapMemoryHealthCheck.Builder, HeapMemoryHealthCheck>, Supplier<HeapMemoryHealthCheck>

Enclosing class:

HeapMemoryHealthCheck

public static final class HeapMemoryHealthCheck.Builder
extends Object
implements Builder<HeapMemoryHealthCheck.Builder, HeapMemoryHealthCheck>

Fluent API builder for HeapMemoryHealthCheck.

Method Summary

Modifier and Type	Method	Description
HeapMemoryHealthCheck	build()	Build the instance from this builder.
HeapMemoryHealthCheck.Builder	config(Config config)	Set up the heap space health check via config key, if present.
HeapMemoryHealthCheck.Builder	thresholdPercent(double threshold)	Threshol percentage.

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 HeapMemoryHealthCheck	get()
default HeapMemoryHealthCheck.Builder	identity()	Instance of this builder as the correct type.
default HeapMemoryHealthCheck.Builder	update(Consumer<HeapMemoryHealthCheck.Builder> consumer)	Update the builder in a fluent API way.

Method Details

build

public HeapMemoryHealthCheck build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<HeapMemoryHealthCheck.Builder, HeapMemoryHealthCheck>

Returns:

instance of the built type

thresholdPercent

public HeapMemoryHealthCheck.Builder thresholdPercent(double threshold)

Threshol percentage. If used memory is above this threshold, reports the system is down.

Parameters:

threshold - threshold percentage (e.g. 87.47)

Returns:

updated builder instance

config

public HeapMemoryHealthCheck.Builder config(Config config)

Set up the heap space health check via config key, if present. Configuration options:

Heap space health check configuration

Key	Default Value	Description	Builder method
"thresholdPercent"	98.0	Minimum percent of heap memory consumed for this health check to fail	thresholdPercent(double)

Parameters:

config - Config node for heap memory

Returns:

updated builder instance