Module io.helidon.webserver.observe.info

Package io.helidon.webserver.observe.info

Interface InfoObserverConfig

All Superinterfaces:

ObserverConfigBase, Prototype.Api, Prototype.Factory<InfoObserver>

All Known Implementing Classes:

InfoObserverConfig.BuilderBase.InfoObserverConfigImpl

public interface InfoObserverConfig
extends Prototype.Api, ObserverConfigBase

Info Observer configuration.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static InfoObserverConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static InfoObserverConfig.Builder	builder(InfoObserverConfig instance)	Create a new fluent API builder from an existing instance.
static InfoObserverConfig	create()	Create a new instance with default values.
static InfoObserverConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static InfoObserverConfig	create(Config config)	Create a new instance from configuration.
String	endpoint()
String	name()	Name of this observer.
Map<String,String>	values()	Values to be exposed using this observability endpoint.

Methods inherited from interface io.helidon.webserver.observe.ObserverConfigBase

enabled

Methods inherited from interface io.helidon.builder.api.Prototype.Factory

build

Method Details

builder

static InfoObserverConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static InfoObserverConfig.Builder builder(InfoObserverConfig 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 InfoObserverConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

@Deprecated
static InfoObserverConfig create(Config config)

Deprecated.

use create(io.helidon.config.Config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static InfoObserverConfig create()

Create a new instance with default values.

Returns:

a new instance

endpoint

String endpoint()

values

Map<String,String> values()

Values to be exposed using this observability endpoint.

Returns:

value map

name

String name()

Description copied from interface: ObserverConfigBase

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

Specified by:

name in interface ObserverConfigBase

Returns:

observer name