Package com.github.jamesnetherton.zulip.client.exception

Class ZulipRateLimitExceededException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.github.jamesnetherton.zulip.client.exception.ZulipRateLimitExceededException

All Implemented Interfaces:

Serializable

public class ZulipRateLimitExceededException
extends Exception

Thrown when the Zulip server returns an HTTP response code of 429. Indicating that the request rate limit has been reached.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ZulipRateLimitExceededException(long rateLimitReset)	Constructs a ZulipRateLimitExceededException.

Method Summary

Modifier and Type	Method	Description
long	getReteLimitReset()	Gets the time at which the Zulip rate limit will be reset.

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 Details

ZulipRateLimitExceededException

public ZulipRateLimitExceededException(long rateLimitReset)

Constructs a ZulipRateLimitExceededException.

Parameters:

rateLimitReset - The time represented as a Unix time, at which the Zulip rate limit will be reset

Method Details

getReteLimitReset

public long getReteLimitReset()

Gets the time at which the Zulip rate limit will be reset. The time is in the format of Unix epoch.

Returns:

The rate limit reset time