Package io.smallrye.faulttolerance.api

Interface Guard.Builder.RateLimitBuilder

Enclosing interface:

Guard.Builder

public static interface Guard.Builder.RateLimitBuilder

Configures a rate limit.

See Also:

• @RateLimit

Method Summary

Modifier and Type	Method	Description
Guard.Builder	done()	Returns the original fault tolerance builder.
Guard.Builder.RateLimitBuilder	limit(int value)	Sets the maximum number of invocations in a time window.
Guard.Builder.RateLimitBuilder	minSpacing(long value, ChronoUnit unit)	Sets the minimum spacing between invocations.
Guard.Builder.RateLimitBuilder	onPermitted(Runnable callback)	Sets a callback that will be invoked when this rate limit permits an invocation.
Guard.Builder.RateLimitBuilder	onRejected(Runnable callback)	Sets a callback that will be invoked when this rate limit rejects an invocation.
Guard.Builder.RateLimitBuilder	type(RateLimitType value)	Sets the type of time windows used for rate limiting.
Guard.Builder.RateLimitBuilder	window(long value, ChronoUnit unit)	Sets the time window length.
default Guard.Builder.RateLimitBuilder	with(Consumer<Guard.Builder.RateLimitBuilder> consumer)

Method Details

limit

Guard.Builder.RateLimitBuilder limit(int value)

Sets the maximum number of invocations in a time window. Defaults to 100.

Parameters:

value - maximum number of invocations in a time window, must be >= 1

Returns:

this rate limit builder

See Also:

• @RateLimit.value

window

Guard.Builder.RateLimitBuilder window(long value,
 ChronoUnit unit)

Sets the time window length. Defaults to 1 second.

Parameters:

value - the time window size, must be >= 1

Returns:

this rate limit builder

See Also:

• @RateLimit.window
• @RateLimit.windowUnit

minSpacing

Guard.Builder.RateLimitBuilder minSpacing(long value,
 ChronoUnit unit)

Sets the minimum spacing between invocations. Defaults to 0.

Parameters:

value - the minimum spacing, must be >= 0

Returns:

this rate limit builder

See Also:

• @RateLimit.minSpacing
• @RateLimit.minSpacingUnit

type

Guard.Builder.RateLimitBuilder type(RateLimitType value)

Sets the type of time windows used for rate limiting. Defaults to RateLimitType.FIXED.

Parameters:

value - the time window type, must not be null

Returns:

this rate limit builder

See Also:

• @RateLimit.type

onPermitted

Guard.Builder.RateLimitBuilder onPermitted(Runnable callback)

Sets a callback that will be invoked when this rate limit permits an invocation.

The callback must be fast and non-blocking and must not throw an exception.

Parameters:

callback - the permitted callback, must not be null

Returns:

this rate limit builder

onRejected

Guard.Builder.RateLimitBuilder onRejected(Runnable callback)

Sets a callback that will be invoked when this rate limit rejects an invocation.

The callback must be fast and non-blocking and must not throw an exception.

Parameters:

callback - the rejected callback, must not be null

Returns:

this rate limit builder

done

Guard.Builder done()

Returns the original fault tolerance builder.

Returns:

the original fault tolerance builder

with

default Guard.Builder.RateLimitBuilder with(Consumer<Guard.Builder.RateLimitBuilder> consumer)