software.reloadly.sdk.core.exception

Class RateLimitException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

software.reloadly.sdk.core.exception.ReloadlyException

software.reloadly.sdk.core.exception.APIException

software.reloadly.sdk.core.exception.RateLimitException

All Implemented Interfaces:

Serializable

public class RateLimitException
extends APIException

Represents a server error when a rate limit has been exceeded.

Getters for limit, remaining and reset corresponds to X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset HTTP headers. If the value of any headers is missing, then a default value -1 will be assigned.

To learn more about rate limits, visit https://api.reloadly.com/docs/policies/rate-limits

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RateLimitException(String message, String path, int httpStatusCode, String errorCode)
RateLimitException(String message, String path, int httpStatusCode, String errorCode, List<Object> details)

Method Summary

Modifier and Type	Method and Description
long	getExpectedResetTimestamp() Getter for the UNIX timestamp of the expected time when the rate limit will reset.
long	getLimit() Getter for the maximum number of requests available in the current time frame.
long	getRemaining() Getter for the number of remaining requests in the current time frame.
void	setExpectedResetTimestamp(long expectedResetTimestamp)
void	setLimit(long limit)
void	setRemaining(long remaining)

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RateLimitException

public RateLimitException(String message,
                          String path,
                          int httpStatusCode,
                          String errorCode)

RateLimitException

public RateLimitException(String message,
                          String path,
                          int httpStatusCode,
                          String errorCode,
                          List<Object> details)

Method Detail

getLimit

public long getLimit()

Getter for the maximum number of requests available in the current time frame.

Returns:

The maximum number of requests or -1 if missing.

setLimit

public void setLimit(long limit)

getRemaining

public long getRemaining()

Getter for the number of remaining requests in the current time frame.

Returns:

Number of remaining requests or -1 if missing.

setRemaining

public void setRemaining(long remaining)

getExpectedResetTimestamp

public long getExpectedResetTimestamp()

Getter for the UNIX timestamp of the expected time when the rate limit will reset.

Returns:

The UNIX timestamp or -1 if missing.

setExpectedResetTimestamp

public void setExpectedResetTimestamp(long expectedResetTimestamp)