Package org.kohsuke.github

Class GHWorkflowRun

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHWorkflowRun

public class GHWorkflowRun
extends GHObject

A workflow run.

Author:

Guillaume Smet

See Also:

GHRepository.getWorkflowRun(long)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHWorkflowRun.Conclusion
static class	GHWorkflowRun.HeadCommit
static class	GHWorkflowRun.Status

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

responseHeaderFields

Constructor Summary

Constructors

Constructor	Description
GHWorkflowRun()

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancel the workflow run.
void	delete()	Delete the workflow run.
URL	getArtifactsUrl()	The artifacts URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts
URL	getCancelUrl()	The cancel URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel
URL	getCheckSuiteUrl()	The check suite URL, like https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374
GHWorkflowRun.Conclusion	getConclusion()	Gets the conclusion of the workflow run.
GHEvent	getEvent()	The type of event that triggered the build.
String	getHeadBranch()	The head branch name the changes are on.
GHWorkflowRun.HeadCommit	getHeadCommit()	The commit of current head.
GHRepository	getHeadRepository()	The repository of current head.
String	getHeadSha()	Gets the HEAD SHA.
URL	getHtmlUrl()	Gets html url.
URL	getJobsUrl()	The jobs URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs
URL	getLogsUrl()	The logs URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs
String	getName()	The name of the workflow run.
List<GHPullRequest>	getPullRequests()	Gets the pull requests participated in this workflow run.
URL	getRerunUrl()	The rerun URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun
long	getRunNumber()	The run number.
GHWorkflowRun.Status	getStatus()	Gets status of the workflow run.
long	getWorkflowId()	The workflow id.
URL	getWorkflowUrl()	The workflow URL, like https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038
void	rerun()	Rerun the workflow run.

Methods inherited from class org.kohsuke.github.GHObject

getCreatedAt, getId, getNodeId, getResponseHeaderFields, getUpdatedAt, getUrl, setResponseHeaderFields, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GHWorkflowRun

public GHWorkflowRun()

Method Detail

getName

public String getName()

The name of the workflow run.

Returns:

the name

getRunNumber

public long getRunNumber()

The run number.

Returns:

the run number

getWorkflowId

public long getWorkflowId()

The workflow id.

Returns:

the workflow id

getHtmlUrl

public URL getHtmlUrl()
               throws IOException

Description copied from class: GHObject

Gets html url.

Specified by:

getHtmlUrl in class GHObject

Returns:

URL of this object for humans, which renders some HTML.

Throws:

IOException - on error

getJobsUrl

public URL getJobsUrl()

The jobs URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs

Returns:

the diff url

getLogsUrl

public URL getLogsUrl()

The logs URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs

Returns:

the diff url

getCheckSuiteUrl

public URL getCheckSuiteUrl()

The check suite URL, like https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374

Returns:

the diff url

getArtifactsUrl

public URL getArtifactsUrl()

The artifacts URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts

Returns:

the diff url

getCancelUrl

public URL getCancelUrl()

The cancel URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel

Returns:

the diff url

getRerunUrl

public URL getRerunUrl()

The rerun URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun

Returns:

the diff url

getWorkflowUrl

public URL getWorkflowUrl()

The workflow URL, like https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038

Returns:

the diff url

getHeadBranch

public String getHeadBranch()

The head branch name the changes are on.

Returns:

head branch name

getHeadSha

public String getHeadSha()

Gets the HEAD SHA.

Returns:

sha for the HEAD commit

getHeadCommit

public GHWorkflowRun.HeadCommit getHeadCommit()

The commit of current head.

Returns:

head commit

getHeadRepository

public GHRepository getHeadRepository()

The repository of current head.

Returns:

head repository

getEvent

public GHEvent getEvent()

The type of event that triggered the build.

Returns:

type of event

getStatus

public GHWorkflowRun.Status getStatus()

Gets status of the workflow run.

Can be UNKNOWN if the value returned by GitHub is unknown from the API.

Returns:

status of the workflow run

getConclusion

public GHWorkflowRun.Conclusion getConclusion()

Gets the conclusion of the workflow run.

Can be UNKNOWN if the value returned by GitHub is unknown from the API.

Returns:

conclusion of the workflow run

getPullRequests

public List<GHPullRequest> getPullRequests()
                                    throws IOException

Gets the pull requests participated in this workflow run. Note this field is only populated for events. When getting a GHWorkflowRun outside of an event, this is always empty.

Returns:

the list of GHPullRequests for this workflow run. Only populated for events.

Throws:

IOException - the io exception

cancel

public void cancel()
            throws IOException

Cancel the workflow run.

Throws:

IOException - the io exception

delete

public void delete()
            throws IOException

Delete the workflow run.

Throws:

IOException - the io exception

rerun

public void rerun()
           throws IOException

Rerun the workflow run.

Throws:

IOException - the io exception