Class HealthObserverConfig.Builder

java.lang.Object

io.helidon.webserver.observe.ObserverConfigBase.BuilderBase<HealthObserverConfig.Builder, HealthObserverConfig>

io.helidon.webserver.observe.health.HealthObserverConfig.BuilderBase<HealthObserverConfig.Builder, HealthObserverConfig>

io.helidon.webserver.observe.health.HealthObserverConfig.Builder

All Implemented Interfaces:

Prototype.Builder<HealthObserverConfig.Builder, HealthObserverConfig>, Builder<HealthObserverConfig.Builder, HealthObserver>, ConfigBuilderSupport.ConfiguredBuilder<HealthObserverConfig.Builder, HealthObserverConfig>, Supplier<HealthObserver>

Enclosing interface:

HealthObserverConfig

public static class HealthObserverConfig.Builder
extends HealthObserverConfig.BuilderBase<HealthObserverConfig.Builder, HealthObserverConfig>
implements Builder<HealthObserverConfig.Builder, HealthObserver>

Fluent API builder for HealthObserver.

Nested Class Summary

Nested classes/interfaces inherited from class HealthObserverConfig.BuilderBase

HealthObserverConfig.BuilderBase.HealthObserverConfigImpl

Modifier and Type	Class	Description
protected static class	HealthObserverConfig.BuilderBase.HealthObserverConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested classes/interfaces inherited from class ObserverConfigBase.BuilderBase

ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl

Modifier and Type	Class	Description
protected static class	ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Method Summary

Modifier and Type	Method	Description
HealthObserver	build()	Create an instance from this builder.
HealthObserverConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class HealthObserverConfig.BuilderBase

addCheck, addCheck, addCheck, addChecks, addExclude, addExcluded, addHealthChecks, clearExclude, clearHealthChecks, config, details, details, endpoint, endpoint, exclude, exclude, from, from, healthChecks, healthChecks, preBuildPrototype, toString, useSystemServices, useSystemServices, validatePrototype

Modifier and Type	Method	Description
HealthObserverConfig.Builder	addCheck(HealthCheck check)	Health checks with implicit types.
HealthObserverConfig.Builder	addCheck(HealthCheck check, HealthCheckType type)	Add the provided health check using an explicit type (may differ from the HealthCheck.type().
HealthObserverConfig.Builder	addCheck(Supplier<HealthCheckResponse> responseSupplier, HealthCheckType type, String name)	Add a health check using the provided response supplier, type, and name.
HealthObserverConfig.Builder	addChecks(HealthCheck[] checks)	Add the provided health checks.
HealthObserverConfig.Builder	addExclude(List<String> exclude)	Health check names to exclude in computing the overall health of the server.
HealthObserverConfig.Builder	addExcluded(String excluded)	Health check names to exclude in computing the overall health of the server.
HealthObserverConfig.Builder	addHealthChecks(List<? extends HealthCheck> healthChecks)	Health checks with implicit types.
HealthObserverConfig.Builder	clearExclude()	Clear all exclude.
HealthObserverConfig.Builder	clearHealthChecks()	Clear all healthChecks.
HealthObserverConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
boolean	details()	Whether details should be printed.
HealthObserverConfig.Builder	details(boolean details)	Whether details should be printed.
String	endpoint()	Endpoint option.
HealthObserverConfig.Builder	endpoint(String endpoint)	Endpoint option.
List<String>	exclude()	Health check names to exclude in computing the overall health of the server.
HealthObserverConfig.Builder	exclude(List<String> exclude)	Health check names to exclude in computing the overall health of the server.
HealthObserverConfig.Builder	from(HealthObserverConfig prototype)	Update this builder from an existing prototype instance.
HealthObserverConfig.Builder	from(HealthObserverConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
List<HealthCheck>	healthChecks()	Health checks with implicit types.
HealthObserverConfig.Builder	healthChecks(List<? extends HealthCheck> healthChecks)	Health checks with implicit types.
protected void	preBuildPrototype()	Handles providers and decorators.
String	toString()
boolean	useSystemServices()	Whether to use discovered health-check services.
HealthObserverConfig.Builder	useSystemServices(boolean useSystemServices)	Whether to use discovered health-check services.
protected void	validatePrototype()	Validates required properties.

Methods inherited from class ObserverConfigBase.BuilderBase

config, enabled, enabled, from, from, name, name

Modifier and Type	Method	Description
Optional<Config>	config()	The config instance used to configure this observer.
boolean	enabled()	Whether this observer is enabled.
HealthObserverConfig.Builder	enabled(boolean enabled)	Whether this observer is enabled.
HealthObserverConfig.Builder	from(ObserverConfigBase prototype)	Update this builder from an existing prototype instance.
HealthObserverConfig.Builder	from(ObserverConfigBase.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<String>	name()	Name of this observer.
HealthObserverConfig.Builder	name(String name)	Name of this observer.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

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

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default HealthObserverConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public HealthObserverConfig buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<HealthObserverConfig.Builder, HealthObserverConfig>

Returns:

an instance of the setup object created from this builder

build

public HealthObserver build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<HealthObserverConfig.Builder, HealthObserver>

Returns:

instance of the built type