Interface ObserverConfigBase

All Superinterfaces:

Prototype.Api

All Known Subinterfaces:

ConfigObserverConfig, io.helidon.webserver.observe.config.ConfigObserverConfigBlueprint, HealthObserverConfig, io.helidon.webserver.observe.health.HealthObserverConfigBlueprint, InfoObserverConfig, io.helidon.webserver.observe.info.InfoObserverConfigBlueprint, LogObserverConfig, io.helidon.webserver.observe.log.LogObserverConfigBlueprint, MetricsObserverConfig, io.helidon.webserver.observe.metrics.MetricsObserverConfigBlueprint, TracingObserverConfig, io.helidon.webserver.observe.tracing.TracingObserverConfigBlueprint

All Known Implementing Classes:

ConfigObserverConfig.BuilderBase.ConfigObserverConfigImpl, HealthObserverConfig.BuilderBase.HealthObserverConfigImpl, InfoObserverConfig.BuilderBase.InfoObserverConfigImpl, LogObserverConfig.BuilderBase.LogObserverConfigImpl, MetricsObserverConfig.BuilderBase.MetricsObserverConfigImpl, ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl, TracingObserverConfig.BuilderBase.TracingObserverConfigImpl

public interface ObserverConfigBase
extends Prototype.Api

Base configuration for any observer that exposes an endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ObserverConfigBase.Builder	Fluent API builder for ObserverConfigBase.
static class	ObserverConfigBase.BuilderBase<BUILDER extends ObserverConfigBase.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends ObserverConfigBase>	Fluent API builder base for ObserverConfigBase.

Method Summary

Modifier and Type	Method	Description
static ObserverConfigBase.Builder	builder()	Create a new fluent API builder to customize configuration.
static ObserverConfigBase.Builder	builder(ObserverConfigBase instance)	Create a new fluent API builder from an existing instance.
Optional<Config>	config()	The config instance used to configure this observer.
static ObserverConfigBase	create(Config config)	Create a new instance from configuration.
boolean	enabled()	Whether this observer is enabled.
String	name()	Name of this observer.

Method Details

builder

static ObserverConfigBase.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static ObserverConfigBase.Builder builder(ObserverConfigBase instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static ObserverConfigBase create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

enabled

boolean enabled()

Whether this observer is enabled.

Returns:

false to disable observer

name

String name()

Name of this observer. Each observer should provide its own default for this property.

Returns:

observer name

config

Optional<Config> config()

The config instance used to configure this observer.

Returns:

config