Module org.kohsuke.github.api

Package org.kohsuke.github

Class GHEventPayload.WorkflowDispatch

java.lang.Object

org.kohsuke.github.GHEventPayload

org.kohsuke.github.GHEventPayload.WorkflowDispatch

Enclosing class:

GHEventPayload

public static class GHEventPayload.WorkflowDispatch
extends GHEventPayload

Occurs when someone triggered a workflow run or sends a POST request to the "Create a workflow dispatch event" endpoint.

See Also:

• workflow dispatch event
• Events that trigger workflows

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

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getInputs()	Gets the map of input parameters passed to the workflow.
String	getRef()	Gets the ref of the branch (e.g. refs/heads/main)
String	getWorkflow()	Gets the path of the workflow file (e.g. .github/workflows/hello-world-workflow.yml).

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

WorkflowDispatch

public WorkflowDispatch()

Create default WorkflowDispatch instance

Method Details

getInputs

public Map<String,Object> getInputs()

Gets the map of input parameters passed to the workflow.

Returns:

the map of input parameters

getRef

public String getRef()

Gets the ref of the branch (e.g. refs/heads/main)

Returns:

the ref of the branch

getWorkflow

public String getWorkflow()

Gets the path of the workflow file (e.g. .github/workflows/hello-world-workflow.yml).

Returns:

the path of the workflow file