Package org.kohsuke.github
Class GHEventPayload
- java.lang.Object
-
- org.kohsuke.github.GHEventPayload
-
- Direct Known Subclasses:
GHEventPayload.CheckRun
,GHEventPayload.CheckSuite
,GHEventPayload.CommitComment
,GHEventPayload.Create
,GHEventPayload.Delete
,GHEventPayload.Deployment
,GHEventPayload.DeploymentStatus
,GHEventPayload.Discussion
,GHEventPayload.Fork
,GHEventPayload.Installation
,GHEventPayload.InstallationRepositories
,GHEventPayload.Issue
,GHEventPayload.IssueComment
,GHEventPayload.Label
,GHEventPayload.Ping
,GHEventPayload.ProjectsV2Item
,GHEventPayload.Public
,GHEventPayload.PullRequest
,GHEventPayload.PullRequestReview
,GHEventPayload.PullRequestReviewComment
,GHEventPayload.Push
,GHEventPayload.Release
,GHEventPayload.Repository
,GHEventPayload.Star
,GHEventPayload.Status
,GHEventPayload.WorkflowDispatch
,GHEventPayload.WorkflowJob
,GHEventPayload.WorkflowRun
public abstract class GHEventPayload extends Object
Base type for types used in databinding of the event payload.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GHEventPayload.CheckRun
A check run event has been created, rerequested, completed, or has a requested_action.static class
GHEventPayload.CheckSuite
A check suite event has been requested, rerequested or completed.static class
GHEventPayload.CommentChanges
Wrapper for changes on issue and pull request review comments action="edited".static class
GHEventPayload.CommitComment
A comment was added to a commit.static class
GHEventPayload.Create
A repository, branch, or tag was created.static class
GHEventPayload.Delete
A branch, or tag was deleted.static class
GHEventPayload.Deployment
A deployment.static class
GHEventPayload.DeploymentStatus
A deployment status.static class
GHEventPayload.Discussion
A discussion was created, edited, deleted, pinned, unpinned, locked, unlocked, transferred, category_changed, answered, or unanswered.static class
GHEventPayload.Fork
A user forked a repository.static class
GHEventPayload.Installation
An installation has been installed, uninstalled, or its permissions have been changed.static class
GHEventPayload.InstallationRepositories
A repository has been added or removed from an installation.static class
GHEventPayload.Issue
A Issue has been assigned, unassigned, labeled, unlabeled, opened, edited, milestoned, demilestoned, closed, or reopened.static class
GHEventPayload.IssueComment
A comment was added to an issue.static class
GHEventPayload.Label
A label was created, edited or deleted.static class
GHEventPayload.Ping
A ping.static class
GHEventPayload.ProjectsV2Item
A project v2 item was archived, converted, created, edited, restored, deleted, or reordered.static class
GHEventPayload.Public
A repository was made public.static class
GHEventPayload.PullRequest
A pull request status has changed.static class
GHEventPayload.PullRequestReview
A review was added to a pull request.static class
GHEventPayload.PullRequestReviewComment
A review comment was added to a pull request.static class
GHEventPayload.Push
A commit was pushed.static class
GHEventPayload.Release
A release was added to the repo.static class
GHEventPayload.Repository
A repository was created, deleted, made public, or made private.static class
GHEventPayload.Star
A star was created or deleted on a repository.static class
GHEventPayload.Status
A git commit status was changed.static class
GHEventPayload.WorkflowDispatch
Occurs when someone triggered a workflow run or sends a POST request to the "Create a workflow dispatch event" endpoint.static class
GHEventPayload.WorkflowJob
A workflow job has been queued, is in progress, or has been completed.static class
GHEventPayload.WorkflowRun
A workflow run was requested or completed.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description String
getAction()
Gets the action for the triggered event.GHAppInstallation
getInstallation()
Gets installation.GHOrganization
getOrganization()
Gets organization.GHRepository
getRepository()
Gets repository.GitHub
getRoot()
Deprecated.For access to theGitHub
instance, use a local copy instead of pulling it out of objects.GHUser
getSender()
Gets the sender ornull
if accessed via the events API.void
setOrganization(GHOrganization organization)
Deprecated.Do not use this method.void
setRepository(GHRepository repository)
Deprecated.Do not use this method.void
setSender(GHUser sender)
Deprecated.Do not use this method.
-
-
-
Method Detail
-
getAction
public String getAction()
Gets the action for the triggered event. Most but not all webhook payloads contain an action property that contains the specific activity that triggered the event.- Returns:
- event action
-
getSender
public GHUser getSender()
Gets the sender ornull
if accessed via the events API.- Returns:
- the sender or
null
if accessed via the events API.
-
setSender
@Deprecated public void setSender(GHUser sender)
Deprecated.Do not use this method. It was added due to incomplete understanding of Jackson binding.Sets sender.- Parameters:
sender
- the sender
-
getRepository
public GHRepository getRepository()
Gets repository.- Returns:
- the repository
-
setRepository
@Deprecated public void setRepository(GHRepository repository)
Deprecated.Do not use this method. It was added due to incomplete understanding of Jackson binding.Sets repository.- Parameters:
repository
- the repository
-
getOrganization
public GHOrganization getOrganization()
Gets organization.- Returns:
- the organization
-
setOrganization
@Deprecated public void setOrganization(GHOrganization organization)
Deprecated.Do not use this method. It was added due to incomplete understanding of Jackson binding.Sets organization.- Parameters:
organization
- the organization
-
getInstallation
public GHAppInstallation getInstallation()
Gets installation.- Returns:
- the installation
-
getRoot
@Deprecated public GitHub getRoot()
Deprecated.For access to theGitHub
instance, use a local copy instead of pulling it out of objects.Get the rootGitHub
instance for this object.- Returns:
- the root
GitHub
instance
-
-