Package org.kohsuke.github

Interface Summary

Interface	Description
HttpConnector	Deprecated. Use GitHubConnector instead.
Reactable	Those GHObjects that can have reactions.
Refreshable	The interface Refreshable.
TrafficInfo	The interface TrafficInfo.

Class Summary

Class	Description
AbuseLimitHandler	Deprecated. Switch to GitHubAbuseLimitHandler.
GHApp	A Github App.
GHAppCreateTokenBuilder	Creates a access token for a GitHub App Installation.
GHAppFromManifest	A GitHub App with the additional attributes returned during its creation.
GHAppInstallation	A Github App Installation.
GHAppInstallationToken	A Github App Installation Token.
GHArtifact	An artifact from a workflow run.
GHAsset	Asset in a release.
GHAuthenticatedAppInstallation	The Github App Installation corresponding to the installation token used in a client.
GHAuthorization	Generated OAuth token.
GHBlob	The type GHBlob.
GHBlobBuilder	Builder pattern for creating a new blob.
GHBranch	A branch in a repository.
GHBranch.Commit	The type Commit.
GHBranchProtection	The type GHBranchProtection.
GHBranchProtection.EnforceAdmins	The type EnforceAdmins.
GHBranchProtection.RequiredReviews	The type RequiredReviews.
GHBranchProtection.RequiredStatusChecks	The type RequiredStatusChecks.
GHBranchProtection.Restrictions	The type Restrictions.
GHBranchProtectionBuilder	Builder to configure the branch protection settings.
GHCheckRun	Represents a check run.
GHCheckRun.Output	Represents an output in a check run to include summary and other results.
GHCheckRunBuilder	Drafts or updates a check run.
GHCheckRunBuilder.Action	The Class Action.
GHCheckRunBuilder.Annotation	The Class Annotation.
GHCheckRunBuilder.Image	The Class Image.
GHCheckRunBuilder.Output	The Class Output.
GHCheckSuite	Represents a check suite.
GHCheckSuite.HeadCommit	The Class HeadCommit.
GHCodeownersError	Represents an error in a CODEOWNERS file.
GHCommit	A commit in a repository.
GHCommit.File	A file that was modified.
GHCommit.GHAuthor	Deprecated. Use GitUser instead.
GHCommit.Parent	The type Parent.
GHCommit.ShortInfo	Short summary of this commit.
GHCommit.Stats	The type Stats.
GHCommitBuilder	Builder pattern for creating a new commit.
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.
GHCommitSearchBuilder	Search 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	The type InnerCommit.
GHCompare.Tree	The type Tree.
GHCompare.User	Deprecated. use GitUser instead.
GHContent	A Content of a repository.
GHContentBuilder	Used to create/update content.
GHContentSearchBuilder	Search code for GHContent.
GHContentUpdateResponse	The response that is returned when updating repository content.
GHCreateRepositoryBuilder	Creates a repository.
GHDeployKey	The type GHDeployKey.
GHDeployment	Represents a deployment.
GHDeploymentBuilder	The type GHDeploymentBuilder.
GHDeploymentStatus	The type GHDeploymentStatus.
GHDeploymentStatusBuilder	Creates a new deployment status.
GHDiscussion	A discussion in GitHub Team.
GHDiscussion.Creator	A GHLabelBuilder that creates a new GHLabel Consumer must call AbstractBuilder.done() to create the new instance.
GHDiscussion.Setter	A GHLabelBuilder that updates a single property per request AbstractBuilder.done() is called automatically after the property is set.
GHDiscussion.Updater	A GHLabelBuilder that allows multiple properties to be updated per request.
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.CheckRun	A check run event has been created, rerequested, completed, or has a requested_action.
GHEventPayload.CheckSuite	A check suite event has been requested, rerequested or completed.
GHEventPayload.CommentChanges	Wrapper for changes on issue and pull request review comments action="edited".
GHEventPayload.CommentChanges.GHFrom	Wrapper for changed values.
GHEventPayload.CommitComment	A comment was added to a commit.
GHEventPayload.Create	A repository, branch, or tag was created.
GHEventPayload.Delete	A branch, or tag was deleted.
GHEventPayload.Deployment	A deployment.
GHEventPayload.DeploymentStatus	A deployment status.
GHEventPayload.Discussion	A discussion was created, edited, deleted, pinned, unpinned, locked, unlocked, transferred, category_changed, answered, or unanswered.
GHEventPayload.Fork	A user forked a repository.
GHEventPayload.Installation	An installation has been installed, uninstalled, or its permissions have been changed.
GHEventPayload.InstallationRepositories	A repository has been added or removed from an installation.
GHEventPayload.Issue	A Issue has been assigned, unassigned, labeled, unlabeled, opened, edited, milestoned, demilestoned, closed, or reopened.
GHEventPayload.IssueComment	A comment was added to an issue.
GHEventPayload.Label	A label was created, edited or deleted.
GHEventPayload.Ping	A ping.
GHEventPayload.ProjectsV2Item	A project v2 item was archived, converted, created, edited, restored, deleted, or reordered.
GHEventPayload.Public	A repository was made public.
GHEventPayload.PullRequest	A pull request status has changed.
GHEventPayload.PullRequestReview	A review was added to a pull request.
GHEventPayload.PullRequestReviewComment	A review comment was added to a pull request.
GHEventPayload.Push	A commit was pushed.
GHEventPayload.Push.PushCommit	Commit in a push.
GHEventPayload.Push.Pusher	The type Pusher.
GHEventPayload.Release	A release was added to the repo.
GHEventPayload.Repository	A repository was created, deleted, made public, or made private.
GHEventPayload.Star	A star was created or deleted on a repository.
GHEventPayload.Status	A git commit status was changed.
GHEventPayload.WorkflowDispatch	Occurs when someone triggered a workflow run or sends a POST request to the "Create a workflow dispatch event" endpoint.
GHEventPayload.WorkflowJob	A workflow job has been queued, is in progress, or has been completed.
GHEventPayload.WorkflowRun	A workflow run was requested or completed.
GHGist	Gist.
GHGistBuilder	Builder pattern for creating a new Gist.
GHGistFile	A file inside GHGist.
GHGistUpdater	Builder pattern for updating a Gist.
GHHook	The type GHHook.
GHInvitation	The type GHInvitation.
GHIssue	Represents an issue on GitHub.
GHIssue.PullRequest	The type PullRequest.
GHIssueBuilder	The type GHIssueBuilder.
GHIssueChanges	Wrapper to define changed fields on issues action="edited".
GHIssueChanges.GHFrom	Wrapper for changed values.
GHIssueComment	Comment to the issue.
GHIssueCommentQueryBuilder	Builds a query for listing comments on an issue.
GHIssueEvent	The type GHIssueEvent.
GHIssueQueryBuilder	The Class GHIssueQueryBuilder.
GHIssueQueryBuilder.ForRepository	The Class ForRepository.
GHIssueRename	The type GHIssueRename.
GHIssueSearchBuilder	Search issues.
GHKey	SSH public key.
GHLabel	The type GHLabel.
GHLabel.Creator	A GHLabelBuilder that creates a new GHLabel Consumer must call AbstractBuilder.done() to create the new instance.
GHLabel.Setter	A GHLabelBuilder that updates a single property per request AbstractBuilder.done() is called automatically after the property is set.
GHLabel.Updater	A GHLabelBuilder that allows multiple properties to be updated per request.
GHLabelChanges	Wrapper to define changed fields on label action="edited".
GHLabelChanges.GHFrom	Wrapper for changed values.
GHLicense	The GitHub Preview API's license information.
GHMarketplaceAccount	Base class for Github Marketplace Account.
GHMarketplaceAccountPlan	A Github Marketplace Account Plan.
GHMarketplaceListAccountBuilder	Returns any accounts associated with a plan, including free plans.
GHMarketplacePendingChange	A Github Marketplace purchase pending change.
GHMarketplacePlan	A Github Marketplace plan.
GHMarketplacePlanForAccountBuilder	Returns the plan associated with current account.
GHMarketplacePurchase	A Github Marketplace purchase.
GHMarketplaceUserPurchase	Github Marketplace User Purchase.
GHMembership	Represents a membership of a user in an organization.
GHMeta	Class that wraps the list of GitHub's IP addresses.
GHMilestone	The type 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	The type GHOrganization.
GHOrganization.RepositoryRole	Repository permissions (roles) for teams and collaborators.
GHPerson	Common part of GHUser and GHOrganization.
GHPersonSet<T extends GHPerson>	Set of GHPerson with helper lookup methods.
GHProject	A GitHub project.
GHProjectCard	The type GHProjectCard.
GHProjectColumn	The type GHProjectColumn.
GHProjectsV2Item	A Projects V2 item in the organization.
GHProjectsV2ItemChanges	An object to track changes in projects_v2_item payloads.
GHProjectsV2ItemChanges.FieldValue	The Class FieldValue.
GHProjectsV2ItemChanges.FromTo	The Class FromTo.
GHProjectsV2ItemChanges.FromToDate	The Class FromToDate.
GHPullRequest	A pull request.
GHPullRequest.AutoMerge	The status of auto merging a GHPullRequest.
GHPullRequestChanges	Wrapper to define changed fields on pull_request action="edited".
GHPullRequestChanges.GHCommitPointer	The Class GHCommitPointer.
GHPullRequestChanges.GHFrom	Wrapper for changed values.
GHPullRequestCommitDetail	Commit detail inside a GHPullRequest.
GHPullRequestCommitDetail.Authorship	Deprecated. Use GitUser
GHPullRequestCommitDetail.Commit	The type Commit.
GHPullRequestCommitDetail.CommitPointer	The type CommitPointer.
GHPullRequestCommitDetail.Tree	The type Tree.
GHPullRequestFileDetail	File detail inside a GHPullRequest.
GHPullRequestQueryBuilder	Lists up pull requests with some filtering and sorting.
GHPullRequestReview	Review to a pull request.
GHPullRequestReviewBuilder	Builds up a creation of new GHPullRequestReview.
GHPullRequestReviewComment	Review comment to the pull request.
GHPullRequestReviewCommentReactions	Reactions for a Pull Request Review comment.
GHQueryBuilder<T>	Used to specify filters, sort order, etc for listing items in a collection.
GHRateLimit	Rate limit.
GHRateLimit.Record	A rate limit record.
GHRateLimit.UnknownLimitRecord	A limit record used as a placeholder when the actual limit is not known.
GHReaction	Reaction to issue, comment, PR, and so on.
GHRef	Provides information on a Git ref from GitHub.
GHRef.GHObject	The type GHObject.
GHRelease	Release in a github repository.
GHReleaseBuilder	Builder pattern for creating a GHRelease.
GHReleaseUpdater	Modifies GHRelease.
GHRepository	A repository on GitHub.
GHRepository.Contributor	The type Contributor.
GHRepository.Setter	A GHRepositoryBuilder that allows multiple properties to be updated per request.
GHRepository.Updater	A GHRepositoryBuilder that allows multiple properties to be updated per request.
GHRepositoryCloneTraffic	Repository clone statistics.
GHRepositoryCloneTraffic.DailyInfo	The type DailyInfo.
GHRepositoryDiscussion	A discussion in the repository.
GHRepositoryDiscussion.Category	Category of a discussion.
GHRepositoryPublicKey	A public key for the given repository.
GHRepositorySearchBuilder	Search repositories.
GHRepositoryStatistics	Statistics for a GitHub repository.
GHRepositoryStatistics.CodeFrequency	The type CodeFrequency.
GHRepositoryStatistics.CommitActivity	The type CommitActivity.
GHRepositoryStatistics.ContributorStats	The type ContributorStats.
GHRepositoryStatistics.ContributorStats.Week	The type Week.
GHRepositoryStatistics.Participation	The type Participation.
GHRepositoryStatistics.PunchCardItem	The type PunchCardItem.
GHRepositoryTraffic	The type GHRepositoryTraffic.
GHRepositoryTraffic.DailyInfo	The type DailyInfo.
GHRepositoryVariable	The type Gh repository variable.
GHRepositoryViewTraffic	Repository view statistics.
GHRepositoryViewTraffic.DailyInfo	The type DailyInfo.
GHRequestedAction	The Class GHRequestedAction.
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.
GHTagObject	Represents an annotated tag in a GHRepository.
GHTeam	A team in GitHub organization.
GHTeamBuilder	Creates a team.
GHThread	A conversation in the notification API.
GHTree	Provides information for Git Trees https://developer.github.com/v3/git/trees/
GHTreeBuilder	Builder pattern for creating a new tree.
GHTreeEntry	Provides information for Git Trees https://developer.github.com/v3/git/trees/
GHUser	Represents an user of GitHub.
GHUserSearchBuilder	Search users.
GHVerification	The commit/tag can be signed by user.
GHVerifiedKey	The type GHVerifiedKey.
GHWorkflow	A workflow.
GHWorkflowJob	A workflow run job.
GHWorkflowJob.Step	The Class Step.
GHWorkflowJobQueryBuilder	Lists up jobs of a workflow run with some filtering.
GHWorkflowRun	A workflow run.
GHWorkflowRun.HeadCommit	The Class HeadCommit.
GHWorkflowRunQueryBuilder	Lists up workflow runs with some filtering and sorting.
GitCommit	The Class GitCommit.
GitHub	Root of the GitHub API.
GitHub.DependentAuthorizationProvider	The Class DependentAuthorizationProvider.
GitHubAbuseLimitHandler	Pluggable strategy to determine what to do when the API rate limit is reached.
GitHubBuilder	Configures connection details and produces GitHub.
GitHubRateLimitHandler	Pluggable strategy to determine what to do when the API rate limit is reached.
GitHubRequest	Class GitHubRequest represents an immutable instance used by the client to determine what information to retrieve from a GitHub server.
GitHubRequest.Entry	The Class Entry.
GitUser	Represents a user in Git who authors/commits a commit.
PagedIterable<T>	Iterable that returns PagedIterator.
PagedIterator<T>	Iterator over a paginated data source.
PagedSearchIterable<T>	PagedIterable enhanced to report search result specific information.
RateLimitChecker	A GitHub API Rate Limit Checker called before each request
RateLimitChecker.LiteralValue	A RateLimitChecker with a simple number as the limit.
RateLimitHandler	Deprecated. Switch to GitHubRateLimitHandler or even better provide RateLimitCheckers.

Enum Summary

Enum	Description
EnforcementLevel	Deprecated.
GHCheckRun.AnnotationLevel	The Enum AnnotationLevel.
GHCheckRun.Conclusion	Final conclusion of the check.
GHCheckRun.Status	The Enum Status.
GHCommentAuthorAssociation	How is an user associated with a repository?.
GHCommitSearchBuilder.Sort	The enum Sort.
GHCommitState	Represents the state of commit.
GHCompare.Status	The enum Status.
GHContentSearchBuilder.Sort	The enum Sort.
GHDeploymentState	Represents the state of deployment.
GHDirection	Sort direction.
GHEvent	Hook event type.
GHFork	The enum for Fork search mode.
GHIssueQueryBuilder.Sort	The enum Sort.
GHIssueSearchBuilder.Sort	The enum Sort.
GHIssueState	The enum GHIssueState.
GHMarketplaceAccountType	GitHub Marketplace Account type.
GHMarketplaceListAccountBuilder.Sort	The enum Sort.
GHMarketplacePriceModel	GitHub Marketplace plan pricing model.
GHMembership.Role	Role of a user in an organization.
GHMembership.State	Whether a role is currently active or waiting for acceptance (pending).
GHMilestoneState	The enum GHMilestoneState.
GHMyself.RepositoryListFilter	Type of repositories returned during listing.
GHOrganization.Permission	The enum Permission.
GHOrganization.Role	Member's role in an organization.
GHPermissionType	The enum GHPermissionType.
GHProject.ProjectState	The enum ProjectState.
GHProject.ProjectStateFilter	The enum ProjectStateFilter.
GHProjectsV2Item.ContentType	The Enum ContentType.
GHProjectsV2ItemChanges.FieldType	The Enum FieldType.
GHPullRequest.MergeMethod	The enum MergeMethod.
GHPullRequestQueryBuilder.Sort	The enum Sort.
GHPullRequestReviewComment.Side	The side of the diff to which the comment applies
GHPullRequestReviewEvent	Action to perform on GHPullRequestReview.
GHPullRequestReviewState	Current state of GHPullRequestReview.
GHRepository.CollaboratorAffiliation	Affiliation of a repository collaborator.
GHRepository.ForkSort	Sort orders for listing forks.
GHRepository.Visibility	Visibility of a repository.
GHRepositoryDiscussion.State	The Enum State.
GHRepositorySearchBuilder.Fork	Deprecated. Kept for backward compatibility.
GHRepositorySearchBuilder.Sort	The enum Sort.
GHRepositorySelection	App installation repository selection.
GHTargetType	App installation target type.
GHTeam.Privacy	The Enum Privacy.
GHTeam.Role	Member's role in a team.
GHUserSearchBuilder.Sort	The enum Sort.
GHVerification.Reason	The possible values for reason in verification object from github.
GHWorkflowRun.Conclusion	The Enum Conclusion.
GHWorkflowRun.Status	The Enum Status.
MarkdownMode	Rendering mode of markdown.
RateLimitTarget	Specifies the rate limit record of an operation.
ReactionContent	Content of reactions.

Exception Summary

Exception	Description
GHException	The type GHException.
GHFileNotFoundException	Request/response contains useful metadata.
GHIOException	Request/response contains useful metadata.
GHOTPRequiredException	This exception is thrown when GitHub is requesting an OTP from the user.
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
BetaApi	Indicates that the method/class/etc marked is a beta implementation of an sdk feature.
Preview	Indicates that the method/class/etc marked maps to GitHub API in the preview period.