net.rithms.riot.api.request.ratelimit

Class RateLimitException

java.lang.Object

java.lang.Throwable

java.lang.Exception

net.rithms.riot.api.RiotApiException

net.rithms.riot.api.request.ratelimit.RateLimitException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

RespectedRateLimitException

public class RateLimitException
extends RiotApiException

Thrown when the Riot Api returns error code 429 (rate limit exceeded). This means that either you or Riot themselves have exceeded their rate limits. You can find out what type of rate limit was violated by calling getRateLimitType().

See Also:

Serialized Form

Field Summary

Fields inherited from class net.rithms.riot.api.RiotApiException

BAD_GATEWAY, BAD_REQUEST, DATA_NOT_FOUND, FORBIDDEN, GATEWAY_TIMEOUT, IOEXCEPTION, METHOD_NOT_ALLOWED, MISSING_API_KEY, MISSING_TOURNAMENT_API_KEY, NOT_IMPLEMENTED, NULLPOINTEREXCEPTION, PARSE_FAILURE, RATE_LIMITED, SERVER_ERROR, TIMEOUT_EXCEPTION, UNAUTHORIZED, UNAVAILABLE, UNPROCESSABLE_ENTITY, UNSUPPORTED_MEDIA_TYPE

Constructor Summary

Constructors

Constructor and Description
RateLimitException(int retryAfter, java.lang.String rateLimitType) Constructs a RateLimitException with the specified attributes.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRateLimitType() Returns the type of rate limit that has been exceeded.
int	getRetryAfter() Returns the time in seconds to wait before the api key limits get refreshed.

Methods inherited from class net.rithms.riot.api.RiotApiException

getErrorCode, getErrorDto, getMessage, getMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RateLimitException

public RateLimitException(int retryAfter,
                          java.lang.String rateLimitType)

Constructs a RateLimitException with the specified attributes.

Parameters:

retryAfter - The time in seconds to wait before the api key limits get refreshed

rateLimitType - The type of rate limit that has been exceeded

Method Detail

getRateLimitType

public java.lang.String getRateLimitType()

Returns the type of rate limit that has been exceeded. This value can either be user, if the user's api key has reached its limits, or service, if Riot has reached some internal limits for that api.

Returns:

The type of rate limit that has been exceeded

getRetryAfter

public int getRetryAfter()

Returns the time in seconds to wait before the api key limits get refreshed.

Returns:

The time in seconds to wait before the api key limits get refreshed