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

Constructor Summary

Constructors

Constructor and Description
Record(int limit, int remaining, long resetEpochSeconds) Instantiates a new Record.
Record(int limit, int remaining, long resetEpochSeconds, String updatedAt) Instantiates a new Record.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
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() Returns 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()
boolean	isExpired() Whether the rate limit reset date indicated by this instance is expired
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Record

public Record(int limit,
              int remaining,
              long resetEpochSeconds)

Instantiates a new Record.

Parameters:

limit - the limit

remaining - the remaining

resetEpochSeconds - the reset epoch seconds

Record

public Record(int limit,
              int remaining,
              long resetEpochSeconds,
              @CheckForNull
              String updatedAt)

Instantiates a new Record.

Parameters:

limit - the limit

remaining - the remaining

resetEpochSeconds - the reset epoch seconds

updatedAt - the updated at

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, use getResetDate() or implement a RateLimitChecker 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

Returns:

true if the rate limit reset date has passed. Otherwise false.

getResetDate

@Nonnull
public Date getResetDate()

Returns 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 a RateLimitChecker instead.

Returns:

the calculated date at which the rate limit has or will reset.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object