Class PrometheusPublisherConfig.Builder

java.lang.Object

io.helidon.metrics.providers.micrometer.PrometheusPublisherConfig.BuilderBase<PrometheusPublisherConfig.Builder, PrometheusPublisherConfig>

io.helidon.metrics.providers.micrometer.PrometheusPublisherConfig.Builder

All Implemented Interfaces:

Prototype.Builder<PrometheusPublisherConfig.Builder, PrometheusPublisherConfig>, Builder<PrometheusPublisherConfig.Builder, PrometheusPublisher>, ConfigBuilderSupport.ConfiguredBuilder<PrometheusPublisherConfig.Builder, PrometheusPublisherConfig>, Supplier<PrometheusPublisher>

Enclosing interface:

PrometheusPublisherConfig

public static class PrometheusPublisherConfig.Builder
extends PrometheusPublisherConfig.BuilderBase<PrometheusPublisherConfig.Builder, PrometheusPublisherConfig>
implements Builder<PrometheusPublisherConfig.Builder, PrometheusPublisher>

Fluent API builder for PrometheusPublisher.

Nested Class Summary

Nested classes/interfaces inherited from class PrometheusPublisherConfig.BuilderBase

PrometheusPublisherConfig.BuilderBase.PrometheusPublisherConfigImpl

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

Method Summary

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

Methods inherited from class PrometheusPublisherConfig.BuilderBase

clearDescriptions, clearInterval, clearName, clearNamingConvention, clearPrefix, config, config, descriptions, descriptions, enabled, enabled, from, from, interval, interval, name, name, namingConvention, namingConvention, namingConvention, namingConvention, preBuildPrototype, prefix, prefix, toString, validatePrototype

Modifier and Type	Method	Description
PrometheusPublisherConfig.Builder	clearDescriptions()	Clear existing value of descriptions.
PrometheusPublisherConfig.Builder	clearInterval()	Clear existing value of interval.
PrometheusPublisherConfig.Builder	clearName()	Clear existing value of name.
PrometheusPublisherConfig.Builder	clearNamingConvention()	Clear existing value of namingConvention.
PrometheusPublisherConfig.Builder	clearPrefix()	Clear existing value of prefix.
protected Optional<Config>	config()	Configuration used to configure this instance.
PrometheusPublisherConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
Optional<Boolean>	descriptions()	Whether to include meter descriptions in Prometheus output.
PrometheusPublisherConfig.Builder	descriptions(boolean descriptions)	Whether to include meter descriptions in Prometheus output.
boolean	enabled()	Whether the configured publisher is enabled.
PrometheusPublisherConfig.Builder	enabled(boolean enabled)	Whether the configured publisher is enabled.
PrometheusPublisherConfig.Builder	from(PrometheusPublisherConfig prototype)	Update this builder from an existing prototype instance.
PrometheusPublisherConfig.Builder	from(PrometheusPublisherConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<Duration>	interval()	Step size used in computing "windowed" statistics.
PrometheusPublisherConfig.Builder	interval(Duration interval)	Step size used in computing "windowed" statistics.
Optional<String>	name()	Name option.
PrometheusPublisherConfig.Builder	name(String name)	Name option.
Optional<PrometheusNamingConventionConfig>	namingConvention()	Prometheus naming convention settings.
PrometheusPublisherConfig.Builder	namingConvention(PrometheusNamingConventionConfig namingConvention)	Prometheus naming convention settings.
PrometheusPublisherConfig.Builder	namingConvention(Consumer<PrometheusNamingConventionConfig.Builder> consumer)	Prometheus naming convention settings.
PrometheusPublisherConfig.Builder	namingConvention(Supplier<? extends PrometheusNamingConventionConfig> supplier)	Prometheus naming convention settings.
protected void	preBuildPrototype()	Handles providers and decorators.
Optional<String>	prefix()	Prefix for Micrometer Prometheus property lookups; this setting does not add a prefix to exported metric names, and the legacy prometheus.histogramFlavor property is accepted for compatibility but ignored with a warning.
PrometheusPublisherConfig.Builder	prefix(String prefix)	Prefix for Micrometer Prometheus property lookups; this setting does not add a prefix to exported metric names, and the legacy prometheus.histogramFlavor property is accepted for compatibility but ignored with a warning.
String	toString()
protected void	validatePrototype()	Validates required properties.

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

Methods inherited from interface Prototype.Builder

self

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

Method Details

buildPrototype

public PrometheusPublisherConfig 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<PrometheusPublisherConfig.Builder, PrometheusPublisherConfig>

Returns:

an instance of the setup object created from this builder

build

public PrometheusPublisher 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<PrometheusPublisherConfig.Builder, PrometheusPublisher>

Returns:

instance of the built type