Package org.kohsuke.github
Class GHRateLimit.Record
- java.lang.Object
-
- org.kohsuke.github.GHRateLimit.Record
-
- Direct Known Subclasses:
GHRateLimit.UnknownLimitRecord
- Enclosing class:
- GHRateLimit
public static class GHRateLimit.Record extends Object
A rate limit record.- Since:
- 1.100
- Author:
- Liam Newman
-
-
Constructor Summary
Constructors Constructor Description Record(int limit, int remaining, long resetEpochSeconds)
Instantiates a new Record.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object o)
Equals.int
getLimit()
Gets the total number of API calls per hour allotted for this connection.int
getRemaining()
Gets the remaining number of requests allowed before this connection will be throttled.Date
getResetDate()
The date at which the rate limit will reset, adjusted to local machine time if the local machine's clock not synchronized with to the same clock as the GitHub server.long
getResetEpochSeconds()
Gets the time in epoch seconds when the rate limit will reset.int
hashCode()
Hash code.boolean
isExpired()
Whether the rate limit reset date indicated by this instance is expired If attempting to wait for the rate limit to reset, consider implementing aRateLimitChecker
instead.String
toString()
To string.
-
-
-
Method Detail
-
getRemaining
public int getRemaining()
Gets the remaining number of requests allowed before this connection will be throttled.- Returns:
- an integer
-
getLimit
public int getLimit()
Gets the total number of API calls per hour allotted for this connection.- Returns:
- an integer
-
getResetEpochSeconds
public long getResetEpochSeconds()
Gets the time in epoch seconds when the rate limit will reset. This is the raw value returned by the server. This value is not adjusted if local machine time is not synchronized with server time. If attempting to check when the rate limit will reset, usegetResetDate()
or implement aRateLimitChecker
instead.- Returns:
- a long representing the time in epoch seconds when the rate limit will reset
- See Also:
getResetDate()
-
isExpired
public boolean isExpired()
Whether the rate limit reset date indicated by this instance is expired If attempting to wait for the rate limit to reset, consider implementing aRateLimitChecker
instead.- Returns:
- true if the rate limit reset date has passed. Otherwise false.
-
getResetDate
@Nonnull public Date getResetDate()
The date at which the rate limit will reset, adjusted to local machine time if the local machine's clock not synchronized with to the same clock as the GitHub server. If attempting to wait for the rate limit to reset, consider implementing aRateLimitChecker
instead.- Returns:
- the calculated date at which the rate limit has or will reset.
-
toString
public String toString()
To string.
-
equals
public boolean equals(Object o)
Equals.
-
-