Package com.adobe.jenkins.github_pr_comment_build

Class GitHubPullRequestCheckRunCause

java.lang.Object

hudson.model.Cause

com.adobe.jenkins.github_pr_comment_build.GitHubPullRequestCheckRunCause

All Implemented Interfaces:

Serializable

public final class GitHubPullRequestCheckRunCause
extends Cause
implements Serializable

Cause for a build triggered by a completed GitHub check run on a pull request.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Cause

Cause.LegacyCodeCause, Cause.RemoteCause, Cause.UpstreamCause, Cause.UserCause, Cause.UserIdCause

Constructor Summary

Constructors

Constructor	Description
GitHubPullRequestCheckRunCause(String checkRunName, String conclusion, String pullRequestUrl)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getCheckRunName()	Retrieves the name of the GitHub check run for this cause.
String	getConclusion()	Retrieves the conclusion of the GitHub check run for this cause.
String	getPullRequestUrl()	Retrieves the URL for the GitHub pull request for this cause.
String	getShortDescription()

Methods inherited from class hudson.model.Cause

onAddedTo, onAddedTo, onLoad, onLoad, print

Methods inherited from class java.lang.Object

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

Constructor Details

GitHubPullRequestCheckRunCause

public GitHubPullRequestCheckRunCause(String checkRunName,
 String conclusion,
 String pullRequestUrl)

Constructor.

Parameters:

checkRunName - the name of the GitHub check run

conclusion - the conclusion of the GitHub check run (e.g. success, neutral, failure)

pullRequestUrl - the URL for the pull request the check run belongs to

Method Details

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in class Cause

getCheckRunName

@Exported(visibility=3)
public String getCheckRunName()

Retrieves the name of the GitHub check run for this cause.

Returns:

the name of the GitHub check run

getConclusion

@Exported(visibility=3)
public String getConclusion()

Retrieves the conclusion of the GitHub check run for this cause.

Returns:

the conclusion of the GitHub check run

getPullRequestUrl

@Exported(visibility=3)
public String getPullRequestUrl()

Retrieves the URL for the GitHub pull request for this cause.

Returns:

the URL for the GitHub pull request