Package org.kohsuke.github

Class GHEventPayload.Create

java.lang.Object

org.kohsuke.github.GHEventPayload

org.kohsuke.github.GHEventPayload.Create

Enclosing class:

GHEventPayload

public static class GHEventPayload.Create
extends GHEventPayload

A repository, branch, or tag was created.

See Also:

• create event
• Git data

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
Create()	Create default Create instance

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets description.
String	getMasterBranch()	Gets default branch.
String	getRef()	Gets ref.
String	getRefType()	Gets ref type.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.

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 Details

Create

public Create()

Create default Create instance

Method Details

getRef

public String getRef()

Gets ref.

Returns:

the ref

getRefType

public String getRefType()

Gets ref type.

Returns:

the ref type

getMasterBranch

public String getMasterBranch()

Gets default branch. Name is an artifact of when "master" was the most common default.

Returns:

the default branch

getDescription

public String getDescription()

Gets description.

Returns:

the description

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