Module org.kohsuke.github.api

Package org.kohsuke.github

Class GHEventPayload.Status

java.lang.Object

org.kohsuke.github.GHEventPayload

org.kohsuke.github.GHEventPayload.Status

Enclosing class:

GHEventPayload

public static class GHEventPayload.Status
extends GHEventPayload

A git commit status was changed.

See Also:

• status event
• Repository Statuses

Nested Class Summary

Nested classes/interfaces inherited from class org.kohsuke.github.GHEventPayload

GHEventPayload.CheckRun, GHEventPayload.CheckSuite, GHEventPayload.CommentChanges, GHEventPayload.CommitComment, GHEventPayload.Create, GHEventPayload.Delete, GHEventPayload.Deployment, GHEventPayload.DeploymentStatus, GHEventPayload.Discussion, GHEventPayload.DiscussionComment, GHEventPayload.Fork, GHEventPayload.Installation, GHEventPayload.InstallationRepositories, GHEventPayload.Issue, GHEventPayload.IssueComment, GHEventPayload.Label, GHEventPayload.Member, GHEventPayload.Membership, GHEventPayload.Ping, GHEventPayload.ProjectsV2Item, GHEventPayload.Public, GHEventPayload.PullRequest, GHEventPayload.PullRequestReview, GHEventPayload.PullRequestReviewComment, GHEventPayload.Push, GHEventPayload.Release, GHEventPayload.Repository, GHEventPayload.Star, GHEventPayload.Status, GHEventPayload.Team, GHEventPayload.TeamAdd, GHEventPayload.WorkflowDispatch, GHEventPayload.WorkflowJob, GHEventPayload.WorkflowRun

Constructor Summary

Constructors

Constructor	Description
Status()	Create default Status instance

Method Summary

Modifier and Type	Method	Description
GHCommit	getCommit()	Gets the commit associated with the status event.
String	getContext()	Gets the status content.
String	getDescription()	Gets the status description.
GHCommitState	getState()	Gets the status state.
String	getTargetUrl()	The optional link added to the status.

Methods inherited from class org.kohsuke.github.GHEventPayload

getAction, getInstallation, getOrganization, getRepository, getSender

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Status

public Status()

Create default Status instance

Method Details

getCommit

public GHCommit getCommit()

Gets the commit associated with the status event.

Returns:

commit

getContext

public String getContext()

Gets the status content.

Returns:

status content

getDescription

public String getDescription()

Gets the status description.

Returns:

status description

getState

public GHCommitState getState()

Gets the status state.

Returns:

status state

getTargetUrl

public String getTargetUrl()

The optional link added to the status.

Returns:

a url