Package org.kohsuke.github

Class GHCheckRun

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHCheckRun

public class GHCheckRun
extends GHObject

Represents a check run.

See Also:

documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHCheckRun.AnnotationLevel
static class	GHCheckRun.Conclusion
static class	GHCheckRun.Output	Represents an output in a check run to include summary and other results.
static class	GHCheckRun.Status

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

responseHeaderFields

Constructor Summary

Constructors

Constructor	Description
GHCheckRun()

Method Summary

Modifier and Type	Method	Description
GHApp	getApp()	Gets the GitHub app this check run belongs to, included in response.
GHCheckSuite	getCheckSuite()	Gets the check suite this check run belongs to
Date	getCompletedAt()	Gets the completed time of the check run in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
String	getConclusion()	Gets conclusion of a completed check run.
URL	getDetailsUrl()	Gets the details URL from which to find full details of the check run on the integrator's site.
String	getExternalId()	Gets a reference for the check run on the integrator's system.
String	getHeadSha()	Gets the HEAD SHA.
URL	getHtmlUrl()	Gets the HTML URL: https://github.com/[owner]/[repo-name]/runs/[check-run-id], usually an GitHub Action page of the check run.
String	getName()	Gets the custom name of this check run.
String	getNodeId()	Gets the global node id to access most objects in GitHub.
GHCheckRun.Output	getOutput()	Gets an output for a check run.
Date	getStartedAt()	Gets the start time of the check run in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
String	getStatus()	Gets status of the check run.

Methods inherited from class org.kohsuke.github.GHObject

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GHCheckRun

public GHCheckRun()

Method Detail

getStatus

public String getStatus()

Gets status of the check run.

Returns:

Status of the check run

See Also:

GHCheckRun.Status

getConclusion

public String getConclusion()

Gets conclusion of a completed check run.

Returns:

Status of the check run

See Also:

GHCheckRun.Conclusion

getName

public String getName()

Gets the custom name of this check run.

Returns:

Name of the check run

getHeadSha

public String getHeadSha()

Gets the HEAD SHA.

Returns:

sha for the HEAD commit

getHtmlUrl

public URL getHtmlUrl()

Gets the HTML URL: https://github.com/[owner]/[repo-name]/runs/[check-run-id], usually an GitHub Action page of the check run.

Specified by:

getHtmlUrl in class GHObject

Returns:

HTML URL

getNodeId

public String getNodeId()

Gets the global node id to access most objects in GitHub.

Overrides:

getNodeId in class GHObject

Returns:

Global node id

See Also:

documentation

getExternalId

public String getExternalId()

Gets a reference for the check run on the integrator's system.

Returns:

Reference id

getDetailsUrl

public URL getDetailsUrl()

Gets the details URL from which to find full details of the check run on the integrator's site.

Returns:

Details URL

getStartedAt

public Date getStartedAt()

Gets the start time of the check run in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

Returns:

Timestamp of the start time

getCompletedAt

public Date getCompletedAt()

Gets the completed time of the check run in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

Returns:

Timestamp of the completed time

getApp

public GHApp getApp()

Gets the GitHub app this check run belongs to, included in response.

Returns:

GitHub App

getCheckSuite

public GHCheckSuite getCheckSuite()

Gets the check suite this check run belongs to

Returns:

Check suite

getOutput

public GHCheckRun.Output getOutput()

Gets an output for a check run.

Returns:

Output of a check run