Class BatchProcessorConfig.BuilderBase<BUILDER extends BatchProcessorConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends BatchProcessorConfig>

java.lang.Object

io.helidon.telemetry.otelconfig.ProcessorConfig.BuilderBase<BUILDER, PROTOTYPE>

io.helidon.telemetry.otelconfig.BatchProcessorConfig.BuilderBase<BUILDER, PROTOTYPE>

Type Parameters:

BUILDER - type of the builder extending this abstract builder

PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()

All Implemented Interfaces:

Prototype.Builder<BUILDER, PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>

Direct Known Subclasses:

BatchProcessorConfig.Builder

Enclosing interface:

BatchProcessorConfig

public abstract static class BatchProcessorConfig.BuilderBase<BUILDER extends BatchProcessorConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends BatchProcessorConfig>
extends ProcessorConfig.BuilderBase<BUILDER, PROTOTYPE>
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>

Fluent API builder base for BatchProcessorConfig.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class ProcessorConfig.BuilderBase

ProcessorConfig.BuilderBase.ProcessorConfigImpl

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
BUILDER	clearMaxExportBatchSize()	Clear existing value of maxExportBatchSize.
BUILDER	clearMaxQueueSize()	Clear existing value of maxQueueSize.
BUILDER	clearScheduleDelay()	Clear existing value of scheduleDelay.
BUILDER	clearTimeout()	Clear existing value of timeout.
BUILDER	config(Config config)	Update builder from configuration (node of this type).
BUILDER	from(BatchProcessorConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(BatchProcessorConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<Integer>	maxExportBatchSize()	Maximum number of items batched for export together.
BUILDER	maxExportBatchSize(int maxExportBatchSize)	Maximum number of items batched for export together.
Optional<Integer>	maxQueueSize()	Maximum number of items retained before discarding excess unexported ones.
BUILDER	maxQueueSize(int maxQueueSize)	Maximum number of items retained before discarding excess unexported ones.
protected void	preBuildPrototype()	Handles providers and decorators.
Optional<Duration>	scheduleDelay()	Delay between consecutive exports.
BUILDER	scheduleDelay(Duration scheduleDelay)	Delay between consecutive exports.
Optional<Duration>	timeout()	Maximum time an export can run before being cancelled.
BUILDER	timeout(Duration timeout)	Maximum time an export can run before being cancelled.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class ProcessorConfig.BuilderBase

addExporters, clearExporters, config, exporters, exporters, from, from, type, type

Modifier and Type	Method	Description
BUILDER	addExporters(List<String> exporters)	Name(s) of the exporter(s) this processor should use; specifying no names uses all configured exporters (or if no exporters are configured, the default OpenTelemetry exporter(s)).
BUILDER	clearExporters()	Clear all exporters.
protected Optional<Config>	config()	Configuration used to configure this instance.
List<String>	exporters()	Name(s) of the exporter(s) this processor should use; specifying no names uses all configured exporters (or if no exporters are configured, the default OpenTelemetry exporter(s)).
BUILDER	exporters(List<String> exporters)	Name(s) of the exporter(s) this processor should use; specifying no names uses all configured exporters (or if no exporters are configured, the default OpenTelemetry exporter(s)).
BUILDER	from(ProcessorConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(ProcessorConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<ProcessorType>	type()	Processor type.
BUILDER	type(ProcessorType type)	Processor type.

Methods inherited from class Object

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

Methods inherited from interface Prototype.Builder

buildPrototype, self

Modifier and Type	Method	Description
PROTOTYPE	buildPrototype()	Create an instance of the Prototype.
default BUILDER	self()	Instance of this builder as the correct type.

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(BatchProcessorConfig prototype)

Update this builder from an existing prototype instance. This method disables automatic service discovery.

Parameters:

prototype - existing prototype to update this builder from

Returns:

updated builder instance

from

public BUILDER from(BatchProcessorConfig.BuilderBase<?,?> builder)

Update this builder from an existing prototype builder instance.

Parameters:

builder - existing builder prototype to update this builder from

Returns:

updated builder instance

config

public BUILDER config(Config config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends BatchProcessorConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends BatchProcessorConfig>

Overrides:

config in class ProcessorConfig.BuilderBase<BUILDER extends BatchProcessorConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends BatchProcessorConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

clearScheduleDelay

public BUILDER clearScheduleDelay()

Clear existing value of scheduleDelay.

Returns:

updated builder instance

See Also:

• scheduleDelay()

scheduleDelay

public BUILDER scheduleDelay(Duration scheduleDelay)

Delay between consecutive exports.

Parameters:

scheduleDelay - delay between consecutive exports

Returns:

updated builder instance

See Also:

• scheduleDelay()

clearMaxQueueSize

public BUILDER clearMaxQueueSize()

Clear existing value of maxQueueSize.

Returns:

updated builder instance

See Also:

• maxQueueSize()

maxQueueSize

public BUILDER maxQueueSize(int maxQueueSize)

Maximum number of items retained before discarding excess unexported ones.

Parameters:

maxQueueSize - maximum number of items kept

Returns:

updated builder instance

See Also:

• maxQueueSize()

clearMaxExportBatchSize

public BUILDER clearMaxExportBatchSize()

Clear existing value of maxExportBatchSize.

Returns:

updated builder instance

See Also:

• maxExportBatchSize()

maxExportBatchSize

public BUILDER maxExportBatchSize(int maxExportBatchSize)

Maximum number of items batched for export together. OpenTelemetry requires this value to not exceed the maxQueueSize().

Parameters:

maxExportBatchSize - maximum number of items batched

Returns:

updated builder instance

See Also:

• maxExportBatchSize()

clearTimeout

public BUILDER clearTimeout()

Clear existing value of timeout.

Returns:

updated builder instance

See Also:

• timeout()

timeout

public BUILDER timeout(Duration timeout)

Maximum time an export can run before being cancelled.

Parameters:

timeout - maximum export time

Returns:

updated builder instance

See Also:

• timeout()

scheduleDelay

public Optional<Duration> scheduleDelay()

Delay between consecutive exports.

Returns:

delay between consecutive exports

maxQueueSize

public Optional<Integer> maxQueueSize()

Maximum number of items retained before discarding excess unexported ones.

Returns:

maximum number of items kept

maxExportBatchSize

public Optional<Integer> maxExportBatchSize()

Maximum number of items batched for export together. OpenTelemetry requires this value to not exceed the maxQueueSize().

Returns:

maximum number of items batched

timeout

public Optional<Duration> timeout()

Maximum time an export can run before being cancelled.

Returns:

maximum export time

toString

public String toString()

Overrides:

toString in class ProcessorConfig.BuilderBase<BUILDER extends BatchProcessorConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends BatchProcessorConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class ProcessorConfig.BuilderBase<BUILDER extends BatchProcessorConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends BatchProcessorConfig>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class ProcessorConfig.BuilderBase<BUILDER extends BatchProcessorConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends BatchProcessorConfig>