org.kohsuke.github

Class GHRateLimit

java.lang.Object

org.kohsuke.github.GHRateLimit

public class GHRateLimit
extends Object

Rate limit.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GHRateLimit.Record A rate limit record.
static class	GHRateLimit.UnknownLimitRecord A limit record used as a placeholder when the the actual limit is not known.

Field Summary

Fields

Modifier and Type	Field and Description
int	limit Deprecated. This value should never have been made public. Use getLimit()
int	remaining Deprecated. This value should never have been made public. Use getRemaining()
Date	reset Deprecated. This value should never have been made public. Use getResetDate()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
GHRateLimit.Record	getCore() The core object provides your rate limit status for all non-search-related resources in the REST API.
int	getLimit() Gets the total number of Core API calls per hour allotted for this connection.
int	getRemaining() Gets the remaining number of Core APIs requests allowed before this connection will be throttled.
Date	getResetDate() Returns the date at which the Core API rate limit will reset.
long	getResetEpochSeconds() Gets the time in epoch seconds when the Core API rate limit will reset.
int	hashCode()
boolean	isExpired() Whether the rate limit reset date for this instance has passed.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

remaining

@Deprecated
public int remaining

Deprecated. This value should never have been made public. Use getRemaining()

Remaining calls that can be made.

limit

@Deprecated
public int limit

Deprecated. This value should never have been made public. Use getLimit()

Allotted API call per hour.

reset

@Deprecated
public Date reset

Deprecated. This value should never have been made public. Use getResetDate()

The time at which the current rate limit window resets in UTC epoch seconds. WARNING: this field was implemented using Date.Date(long) which expects UTC epoch milliseconds, so this Date instance is meaningless as a date. To use this field in any meaningful way, it must be converted to a long using Date.getTime() multiplied by 1000.

Method Detail

getResetDate

@Nonnull
public Date getResetDate()

Returns the date at which the Core API rate limit will reset.

Returns:

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

getRemaining

public int getRemaining()

Gets the remaining number of Core APIs requests allowed before this connection will be throttled.

Returns:

an integer

Since:

1.100

getLimit

public int getLimit()

Gets the total number of Core API calls per hour allotted for this connection.

Returns:

an integer

Since:

1.100

getResetEpochSeconds

public long getResetEpochSeconds()

Gets the time in epoch seconds when the Core API rate limit will reset.

Returns:

a long

Since:

1.100

isExpired

public boolean isExpired()

Whether the rate limit reset date for this instance has passed.

Returns:

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

Since:

1.100

getCore

@Nonnull
public GHRateLimit.Record getCore()

The core object provides your rate limit status for all non-search-related resources in the REST API.

Returns:

a rate limit record

Since:

1.100

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