Class ThroughputLimitConfig.Builder

java.lang.Object

io.helidon.common.concurrency.limits.ThroughputLimitConfig.BuilderBase<ThroughputLimitConfig.Builder, ThroughputLimitConfig>

io.helidon.common.concurrency.limits.ThroughputLimitConfig.Builder

All Implemented Interfaces:

Prototype.Builder<ThroughputLimitConfig.Builder, ThroughputLimitConfig>, Builder<ThroughputLimitConfig.Builder, ThroughputLimit>, ConfigBuilderSupport.ConfiguredBuilder<ThroughputLimitConfig.Builder, ThroughputLimitConfig>, Supplier<ThroughputLimit>

Enclosing interface:

ThroughputLimitConfig

public static class ThroughputLimitConfig.Builder
extends ThroughputLimitConfig.BuilderBase<ThroughputLimitConfig.Builder, ThroughputLimitConfig>
implements Builder<ThroughputLimitConfig.Builder, ThroughputLimit>

Fluent API builder for ThroughputLimit.

Nested Class Summary

Nested classes/interfaces inherited from class ThroughputLimitConfig.BuilderBase

ThroughputLimitConfig.BuilderBase.ThroughputLimitConfigImpl

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

Method Summary

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

Methods inherited from class ThroughputLimitConfig.BuilderBase

amount, amount, clearClock, clearSemaphore, clock, clock, config, config, duration, duration, enableMetrics, enableMetrics, fair, fair, from, from, name, name, preBuildPrototype, queueLength, queueLength, queueTimeout, queueTimeout, rateLimitingAlgorithm, rateLimitingAlgorithm, semaphore, semaphore, toString, validatePrototype

Modifier and Type	Method	Description
int	amount()	Number of operations to allow during the relevant time window.
ThroughputLimitConfig.Builder	amount(int amount)	Number of operations to allow during the relevant time window.
ThroughputLimitConfig.Builder	clearClock()	Clear existing value of clock.
ThroughputLimitConfig.Builder	clearSemaphore()	Clear existing value of semaphore.
Optional<Supplier<Long>>	clock()	A clock that supplies nanosecond time.
ThroughputLimitConfig.Builder	clock(Supplier<Long> clock)	A clock that supplies nanosecond time.
protected Optional<Config>	config()	Configuration used to configure this instance.
ThroughputLimitConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
Duration	duration()	Duration of the time window over which operations will be counted.
ThroughputLimitConfig.Builder	duration(Duration duration)	Duration of the time window over which operations will be counted.
boolean	enableMetrics()	Whether to collect metrics for the throughput limit implementation.
ThroughputLimitConfig.Builder	enableMetrics(boolean enableMetrics)	Whether to collect metrics for the throughput limit implementation.
boolean	fair()	Whether the Semaphore should be Semaphore.isFair().
ThroughputLimitConfig.Builder	fair(boolean fair)	Whether the Semaphore should be Semaphore.isFair().
ThroughputLimitConfig.Builder	from(ThroughputLimitConfig prototype)	Update this builder from an existing prototype instance.
ThroughputLimitConfig.Builder	from(ThroughputLimitConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
String	name()	Name of this instance.
ThroughputLimitConfig.Builder	name(String name)	Name of this instance.
protected void	preBuildPrototype()	Handles providers and decorators.
int	queueLength()	How many requests can be enqueued waiting for a permit.
ThroughputLimitConfig.Builder	queueLength(int queueLength)	How many requests can be enqueued waiting for a permit.
Duration	queueTimeout()	How long to wait for a permit when enqueued.
ThroughputLimitConfig.Builder	queueTimeout(Duration queueTimeout)	How long to wait for a permit when enqueued.
RateLimitingAlgorithmType	rateLimitingAlgorithm()	The rate limiting algorithm to apply.
ThroughputLimitConfig.Builder	rateLimitingAlgorithm(RateLimitingAlgorithmType rateLimitingAlgorithm)	The rate limiting algorithm to apply.
Optional<Semaphore>	semaphore()	Explicitly configured semaphore.
ThroughputLimitConfig.Builder	semaphore(Semaphore semaphore)	Explicitly configured semaphore.
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 ThroughputLimit	get()
default ThroughputLimitConfig.Builder	identity()	Instance of this builder as the correct type.
default ThroughputLimitConfig.Builder	update(Consumer<ThroughputLimitConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

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

Method Details

buildPrototype

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

Returns:

an instance of the setup object created from this builder

build

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

Returns:

instance of the built type