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	The Enum AnnotationLevel.
static class	GHCheckRun.Conclusion	Final conclusion of the check.
static class	GHCheckRun.Output	Represents an output in a check run to include summary and other results.
static class	GHCheckRun.Status	The Enum 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.
GHCheckRun.Conclusion	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.
List<GHPullRequest>	getPullRequests()	Gets the pull requests participated in this check run.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
Date	getStartedAt()	Gets the start time of the check run in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
GHCheckRun.Status	getStatus()	Gets status of the check run.
GHCheckRunBuilder	update()	Updates this 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

@WithBridgeMethods(value=java.lang.String.class,
                   adapterMethod="statusAsStr")
public GHCheckRun.Status getStatus()

Gets status of the check run.

Returns:

Status of the check run

See Also:

GHCheckRun.Status

getConclusion

@WithBridgeMethods(value=java.lang.String.class,
                   adapterMethod="conclusionAsStr")
public GHCheckRun.Conclusion 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

getPullRequests

public List<GHPullRequest> getPullRequests()
                                    throws IOException

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

Returns:

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

Throws:

IOException - the io exception

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

update

@Preview(ANTIOPE)
@NonNull
public GHCheckRunBuilder update()

Updates this check run.

Returns:

a builder which you should customize, then call GHCheckRunBuilder.create()

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