Package org.kohsuke.github

Interface Summary

Interface	Description
HttpConnector	Pluggability for customizing HTTP request behaviors or using altogether different library.

Class Summary

Class	Description
AbuseLimitHandler	Pluggable strategy to determine what to do when the API abuse limit is hit.
GHAsset	Asset in a release.
GHAuthorization	Generated OAuth token
GHBranch	A branch in a repository.
GHBranch.Commit
GHCommit	A commit in a repository.
GHCommit.File	A file that was modified.
GHCommit.GHAuthor	Deprecated Use GitUser instead.
GHCommit.Parent
GHCommit.ShortInfo	Short summary of this commit.
GHCommit.Stats
GHCommitComment	A comment attached to a commit (or a specific line in a specific file of a commit.)
GHCommitPointer	Identifies a commit in GHPullRequest.
GHCommitQueryBuilder	Builds up query for listing commits.
GHCommitStatus	Represents a status of a commit.
GHCompare	The model user for comparing 2 commits in the GitHub API.
GHCompare.Commit	Compare commits had a child commit element with additional details we want to capture.
GHCompare.InnerCommit
GHCompare.Tree
GHCompare.User	Deprecated use GitUser instead.
GHContent	A Content of a repository.
GHContentSearchBuilder	Search code for GHContent.
GHContentUpdateResponse	The response that is returned when updating repository content.
GHCreateRepositoryBuilder	Creates a repository
GHDeployKey
GHDeployment
GHDeploymentBuilder
GHDeploymentStatus
GHDeploymentStatusBuilder
GHEmail	Represents an email of GitHub.
GHEventInfo	Represents an event.
GHEventInfo.GHEventRepository	Inside the event JSON model, GitHub uses a slightly different format.
GHEventPayload	Base type for types used in databinding of the event payload.
GHEventPayload.IssueComment	A comment was added to an issue
GHEventPayload.PullRequest	A pull request status has changed.
GHEventPayload.Push	A commit was pushed.
GHEventPayload.Push.PushCommit	Commit in a push
GHGist	Gist
GHGistBuilder	Builder pattern for creating a new Gist.
GHGistFile	A file inside GHGist
GHHook
GHIssue	Represents an issue on GitHub.
GHIssue.Label	Deprecated use GHLabel
GHIssue.PullRequest
GHIssueBuilder
GHIssueComment	Comment to the issue
GHIssueSearchBuilder	Search issues.
GHKey	SSH public key.
GHLabel
GHLicense	Deprecated
GHMilestone
GHMyself	Represents the account that's logging into GitHub.
GHNotificationStream	Listens to GitHub notification stream.
GHObject	Most (all?) domain objects in GitHub seems to have these 4 properties.
GHOrganization
GHPerson	Common part of GHUser and GHOrganization.
GHPersonSet<T extends GHPerson>	Set of GHPerson with helper lookup methods.
GHPullRequest	A pull request.
GHPullRequestCommitDetail	Commit detail inside a GHPullRequest.
GHPullRequestCommitDetail.Authorship	Deprecated Use GitUser
GHPullRequestCommitDetail.Commit
GHPullRequestCommitDetail.CommitPointer
GHPullRequestCommitDetail.Tree
GHPullRequestFileDetail	File detail inside a GHPullRequest.
GHPullRequestQueryBuilder	Lists up pull requests with some filtering and sorting.
GHPullRequestReviewComment	Review comment to the pull request
GHQueryBuilder<T>	Used to specify filters, sort order, etc for listing items in a collection.
GHRateLimit	Rate limit.
GHRef	Provides information on a Git ref from GitHub.
GHRef.GHObject
GHRelease	Release in a github repository.
GHReleaseBuilder	Builder pattern for creating a GHRelease
GHRepository	A repository on GitHub.
GHRepository.Contributor
GHRepositorySearchBuilder	Search repositories.
GHSearchBuilder<T>	Base class for various search builders.
GHStargazer	A stargazer at a repository on GitHub.
GHSubscription	Represents your subscribing to a repository / conversation thread..
GHTag	Represents a tag in GHRepository
GHTeam	A team in GitHub organization.
GHThread	A conversation in the notification API.
GHTree	Provides information for Git Trees https://developer.github.com/v3/git/trees/
GHTreeEntry	Provides information for Git Trees https://developer.github.com/v3/git/trees/
GHUser	Represents an user of GitHub.
GHUserSearchBuilder	Search users.
GHVerifiedKey
GitHub	Root of the GitHub API.
GitHubBuilder	Configures connection details and produces GitHub.
GitUser	Represents a user in Git who authors/commits a commit.
PagedIterable<T>	Iterable that returns PagedIterator
PagedIterator<T>	Iterator over a pagenated data source.
PagedSearchIterable<T>	PagedIterable enhanced to report search result specific information.
RateLimitHandler	Pluggable strategy to determine what to do when the API rate limit is reached.

Enum Summary

Enum	Description
EnforcementLevel
GHCommitState	Represents the state of commit
GHCompare.Status
GHDeploymentState	Represents the state of deployment
GHDirection	Sort direction
GHEvent	Hook event type.
GHIssueSearchBuilder.Sort
GHIssueState
GHMilestoneState
GHMyself.RepositoryListFilter	Type of repositories returned during listing.
GHOrganization.Permission
GHPullRequestQueryBuilder.Sort
GHRepository.ForkSort	Sort orders for listing forks
GHRepositorySearchBuilder.Sort
GHUserSearchBuilder.Sort
MarkdownMode	Rendering mode of markdown.

Exception Summary

Exception	Description
GHException
HttpException	IOException for http exceptions because HttpURLConnection throws un-discerned IOException and it can help to know the http response code to decide how to handle an http exceptions.

Annotation Types Summary

Annotation Type	Description
Preview	Indicates that the method/class/etc marked maps to GitHub API in the preview period.