Record Class RateLimitDecision.Throttled

java.lang.Object

java.lang.Record

com.svenruppert.jsentinel.ratelimiting.RateLimitDecision.Throttled

Record Components:

eventsInWindow - observed count

limit - configured limit

window - configured window

retryAfter - duration until the oldest in-window event falls out of the window — a fair lower bound for Retry-After; non-null, non-negative

All Implemented Interfaces:

RateLimitDecision

Enclosing interface:

RateLimitDecision

public static record RateLimitDecision.Throttled(int eventsInWindow, int limit, Duration window, Duration retryAfter)
extends Record
implements RateLimitDecision

The event was refused — the per-window count is already at or above the configured limit.

Nested Class Summary

Nested classes/interfaces inherited from interface RateLimitDecision

RateLimitDecision.Allowed, RateLimitDecision.Throttled

Modifier and Type	Interface	Description
static final record	RateLimitDecision.Allowed	The event was admitted; the caller proceeds.
static final record	RateLimitDecision.Throttled	The event was refused — the per-window count is already at or above the configured limit.

Constructor Summary

Constructors

Constructor	Description
Throttled(int eventsInWindow, int limit, Duration window, Duration retryAfter)	Validates the components.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	eventsInWindow()	Returns the value of the eventsInWindow record component.
final int	hashCode()	Returns a hash code value for this object.
int	limit()	Returns the value of the limit record component.
Duration	retryAfter()	Returns the value of the retryAfter record component.
final String	toString()	Returns a string representation of this record class.
Duration	window()	Returns the value of the window record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Throttled

public Throttled(int eventsInWindow,
 int limit,
 Duration window,
 Duration retryAfter)

Validates the components.

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

eventsInWindow

public int eventsInWindow()

Returns the value of the eventsInWindow record component.

Specified by:

eventsInWindow in interface RateLimitDecision

Returns:

the value of the eventsInWindow record component

limit

public int limit()

Returns the value of the limit record component.

Specified by:

limit in interface RateLimitDecision

Returns:

the value of the limit record component

window

public Duration window()

Returns the value of the window record component.

Specified by:

window in interface RateLimitDecision

Returns:

the value of the window record component

retryAfter

public Duration retryAfter()

Returns the value of the retryAfter record component.

Returns:

the value of the retryAfter record component