DiskSpaceHealthCheck.Builder (Helidon Project 2.6.13 API)

java.lang.Object
- io.helidon.health.checks.DiskSpaceHealthCheck.Builder

All Implemented Interfaces:

Builder<DiskSpaceHealthCheck>, Supplier<DiskSpaceHealthCheck>

Enclosing class:

DiskSpaceHealthCheck
```
public static final class DiskSpaceHealthCheck.Builder
extends Object
implements Builder<DiskSpaceHealthCheck>
```
Fluent API builder for DiskSpaceHealthCheck.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DiskSpaceHealthCheck`	`build()`	Build the instance from this builder.
`DiskSpaceHealthCheck.Builder`	`config(Config config)`	Set up the disk space health check via config keys, if present.
`DiskSpaceHealthCheck.Builder`	`path(String path)`	Path on the file system to find a file system.
`DiskSpaceHealthCheck.Builder`	`path(Path path)`	Path on the file system to find a file system.
`DiskSpaceHealthCheck.Builder`	`thresholdPercent(double threshold)`	Threshold percent.

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

Methods inherited from interface io.helidon.common.Builder
get

Method Detail

build
```
public DiskSpaceHealthCheck build()
```
Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<DiskSpaceHealthCheck>

Returns:

instance of the built type

path
```
public DiskSpaceHealthCheck.Builder path(String path)
```
Path on the file system to find a file system.

Parameters:

path - path to use

Returns:

updated builder instance

See Also:

path(java.nio.file.Path)

path
```
public DiskSpaceHealthCheck.Builder path(Path path)
```
Path on the file system to find a file system.

Parameters:

path - path to use

Returns:

updated builder instance

thresholdPercent
```
public DiskSpaceHealthCheck.Builder thresholdPercent(double threshold)
```
Threshold percent. When disk is fuller than this percentage, health is switched to down.

Parameters:

threshold - percentage

Returns:

updated builder instance

config

public DiskSpaceHealthCheck.Builder config(Config config)

Set up the disk space health check via config keys, if present. Configuration options:

Disk space health check configuration
Key	Default Value	Description	Builder method
"path"	"."	Path for the device for which this health checks available space	`path(Path)` or `path(String)`
"thresholdPercent"	99.999	Minimum percent of disk space consumed for this health check to fail	`thresholdPercent(double)`

Parameters:: config - Config node for disk space
Returns:: updated builder instance