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.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

Constructor Summary

Constructors

Constructor	Description
Status()

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.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
GHCommitState	getState()	Gets the status state.
String	getTargetUrl()	The optional link added to the status.
void	setCommit(GHCommit commit)	Deprecated. Do not use this method.
void	setState(GHCommitState state)	Deprecated. Do not use this method.

Methods inherited from class org.kohsuke.github.GHEventPayload

getAction, getInstallation, getOrganization, getRepository, getSender, setOrganization, setRepository, setSender

Methods inherited from class java.lang.Object

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

Constructor Detail

Status

public Status()

Method Detail

getContext

public String getContext()

Gets the status content.

Returns:

status content

getTargetUrl

public String getTargetUrl()

The optional link added to the status.

Returns:

a url

getDescription

public String getDescription()

Gets the status description.

Returns:

status description

getState

public GHCommitState getState()

Gets the status state.

Returns:

status state

setState

@Deprecated
public void setState(GHCommitState state)

Deprecated.

Do not use this method. It was added due to incomplete understanding of Jackson binding.

Sets the status stage.

Parameters:

state - status state

getCommit

public GHCommit getCommit()

Gets the commit associated with the status event.

Returns:

commit

setCommit

@Deprecated
public void setCommit(GHCommit commit)

Deprecated.

Do not use this method. It was added due to incomplete understanding of Jackson binding.

Sets the commit associated with the status event.

Parameters:

commit - commit

getRoot

@Deprecated
public GitHub getRoot()

Deprecated.

For access to the GitHub instance, use a local copy instead of pulling it out of objects.

Get the root GitHub instance for this object.

Returns:

the root GitHub instance