Package io.quarkus.smallrye.faulttolerance.runtime.config

Interface SmallRyeFaultToleranceConfig.StrategiesConfig.RateLimitConfig

Enclosing interface:

SmallRyeFaultToleranceConfig.StrategiesConfig

public static interface SmallRyeFaultToleranceConfig.StrategiesConfig.RateLimitConfig

Method Summary

Modifier and Type	Method	Description
Optional<Boolean>	enabled()	Whether the @RateLimit strategy is enabled.
OptionalLong	minSpacing()	Minimum time between two consecutive invocations.
Optional<ChronoUnit>	minSpacingUnit()	The unit for minSpacing().
Optional<io.smallrye.faulttolerance.api.RateLimitType>	type()	The type of type windows used for rate limiting.
OptionalInt	value()	The maximum number of invocations in a time window.
OptionalLong	window()	The time window length.
Optional<ChronoUnit>	windowUnit()	The unit for window().

Method Details

enabled

@ConfigDocDefault("true")
Optional<Boolean> enabled()

Whether the @RateLimit strategy is enabled.

minSpacing

@ConfigDocDefault("0")
OptionalLong minSpacing()

Minimum time between two consecutive invocations. If the time between two consecutive invocations is shorter, the second invocation is rejected.

See Also:

• RateLimit.minSpacing()

minSpacingUnit

Optional<ChronoUnit> minSpacingUnit()

The unit for minSpacing().

See Also:

• RateLimit.minSpacingUnit()

type

@ConfigDocDefault("fixed")
Optional<io.smallrye.faulttolerance.api.RateLimitType> type()

The type of type windows used for rate limiting.

See Also:

• RateLimit.type()

value

@ConfigDocDefault("100")
OptionalInt value()

The maximum number of invocations in a time window.

See Also:

• RateLimit.value()

window

@ConfigDocDefault("1 second")
OptionalLong window()

The time window length.

See Also:

• RateLimit.window()

windowUnit

Optional<ChronoUnit> windowUnit()

The unit for window().

See Also:

• RateLimit.windowUnit()