Package org.kohsuke.github
Class GitHubRateLimitHandler
java.lang.Object
org.kohsuke.github.GitHubRateLimitHandler
- Direct Known Subclasses:
RateLimitHandler
Pluggable strategy to determine what to do when the API rate limit is reached.
- Author:
- Kohsuke Kawaguchi, Liam Newman
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract void
onError
(GitHubConnectorResponse connectorResponse) Called when the library encounters HTTP error indicating that the API rate limit has been exceeded.
-
Constructor Details
-
GitHubRateLimitHandler
public GitHubRateLimitHandler()
-
-
Method Details
-
onError
Called when the library encounters HTTP error indicating that the API rate limit has been exceeded.Any exception thrown from this method will cause the request to fail, and the caller of github-api will receive an exception. If this method returns normally, another request will be attempted. For that to make sense, the implementation needs to wait for some time.
- Parameters:
connectorResponse
- Response information for this request.- Throws:
IOException
- the io exception- See Also:
-