Package org.jenkinsci.plugins.github.pullrequest

Class GitHubPRCause

java.lang.Object

hudson.model.Cause

com.github.kostyasha.github.integration.generic.GitHubCause<GitHubPRCause>

org.jenkinsci.plugins.github.pullrequest.GitHubPRCause

public class GitHubPRCause
extends GitHubCause<GitHubPRCause>

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
GitHubPRCause()
GitHubPRCause(String headSha, int number, boolean mergeable, String targetBranch, String sourceBranch, String prAuthorEmail, String title, URL htmlUrl, String sourceRepoOwner, Set<String> labels, org.kohsuke.github.GHUser triggerSender, boolean skip, String reason, String commitAuthorName, String commitAuthorEmail, String state)
GitHubPRCause(GitHubPRCause orig)	Copy constructor
GitHubPRCause(GitHubPRPullRequest pr, org.kohsuke.github.GHUser triggerSender, boolean skip, String reason)	Deprecated.
GitHubPRCause(GitHubPRPullRequest pr, org.kohsuke.github.GHUser triggerSender, GitHubPRRepository localRepo, boolean skip, String reason)
GitHubPRCause(org.kohsuke.github.GHPullRequest remotePr, String reason, boolean skip)	Deprecated.
GitHubPRCause(org.kohsuke.github.GHPullRequest remotePr, GitHubPRRepository localRepo, String reason, boolean skip)

Method Summary

Modifier and Type	Method	Description
GitHubSCMHead<GitHubPRCause>	createSCMHead(String sourceId)
boolean	equals(Object o)
void	fillParameters(List<ParameterValue> params)
String	getBody()
String	getCommentAuthorEmail()	When trigger by comment, author email of comment.
String	getCommentAuthorName()	When trigger by comment, author of comment.
String	getCommentBody()	When trigger by comment, body of comment.
String	getCommentBodyMatch()	When trigger by comment, string matched to pattern.
String	getCommitAuthorEmail()
String	getCommitAuthorName()
String	getCondRef()
String	getHeadSha()
Set<String>	getLabels()
int	getNumber()
String	getPrAuthorEmail()
String	getPRAuthorEmail()
String	getShortDescription()
String	getSourceBranch()
String	getSourceRepoOwner()
String	getState()
String	getTargetBranch()
String	getTriggerSenderEmail()
String	getTriggerSenderName()
int	hashCode()
boolean	isMergeable()
static GitHubPRCause	newGitHubPRCause()
void	onAddedTo(Run run)
String	toString()
GitHubPRCause	withBody(String body)
GitHubPRCause	withCommentAuthorEmail(String commentAuthorEmail)
GitHubPRCause	withCommentAuthorName(String commentAuthorName)
GitHubPRCause	withCommentBody(String commentBody)
GitHubPRCause	withCommentBodyMatch(String commentBodyMatch)
GitHubPRCause	withCommitAuthorEmail(String commitAuthorEmail)
GitHubPRCause	withCommitAuthorName(String commitAuthorName)
GitHubPRCause	withCondRef(String condRef)
GitHubPRCause	withHeadSha(String headSha)
GitHubPRCause	withLabels(Set<String> labels)
GitHubPRCause	withLocalRepo(GitHubRepository localRepo)
GitHubPRCause	withMergeable(boolean mergeable)
GitHubPRCause	withNumber(int number)
GitHubPRCause	withPrAuthorEmail(String prAuthorEmail)
GitHubPRCause	withSourceBranch(String sourceBranch)
GitHubPRCause	withSourceRepoOwner(String sourceRepoOwner)
GitHubPRCause	withTargetBranch(String targetBranch)
GitHubPRCause	withTriggerSenderEmail(String triggerSenderEmail)
GitHubPRCause	withTriggerSenderName(String triggerSenderName)

Methods inherited from class com.github.kostyasha.github.integration.generic.GitHubCause

createSCMRevision, getAbbreviatedTitle, getGitUrl, getHtmlUrl, getPollingLog, getReason, getRemoteData, getSshUrl, getTitle, isSkip, setPollingLog, setPollingLogFile, skipTrigger, withGitUrl, withHtmlUrl, withPollingLog, withReason, withRemoteData, withSkip, withSshUrl, withTitle

Methods inherited from class hudson.model.Cause

onAddedTo, onLoad, onLoad, print

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

GitHubPRCause

public GitHubPRCause()

GitHubPRCause

public GitHubPRCause(org.kohsuke.github.GHPullRequest remotePr,
 GitHubPRRepository localRepo,
 String reason,
 boolean skip)

GitHubPRCause

@Deprecated
public GitHubPRCause(org.kohsuke.github.GHPullRequest remotePr,
 String reason,
 boolean skip)

Deprecated.

GitHubPRCause

public GitHubPRCause(GitHubPRPullRequest pr,
 org.kohsuke.github.GHUser triggerSender,
 GitHubPRRepository localRepo,
 boolean skip,
 String reason)

GitHubPRCause

@Deprecated
public GitHubPRCause(GitHubPRPullRequest pr,
 org.kohsuke.github.GHUser triggerSender,
 boolean skip,
 String reason)

Deprecated.

GitHubPRCause

public GitHubPRCause(String headSha,
 int number,
 boolean mergeable,
 String targetBranch,
 String sourceBranch,
 String prAuthorEmail,
 String title,
 URL htmlUrl,
 String sourceRepoOwner,
 Set<String> labels,
 org.kohsuke.github.GHUser triggerSender,
 boolean skip,
 String reason,
 String commitAuthorName,
 String commitAuthorEmail,
 String state)

GitHubPRCause

public GitHubPRCause(GitHubPRCause orig)

Copy constructor

Method Details

withLocalRepo

public GitHubPRCause withLocalRepo(@NonNull
 GitHubRepository localRepo)

Overrides:

withLocalRepo in class GitHubCause<GitHubPRCause>

newGitHubPRCause

public static GitHubPRCause newGitHubPRCause()

withHeadSha

public GitHubPRCause withHeadSha(String headSha)

See Also:

• headSha

withNumber

public GitHubPRCause withNumber(int number)

See Also:

• number

withMergeable

public GitHubPRCause withMergeable(boolean mergeable)

See Also:

• mergeable

withTargetBranch

public GitHubPRCause withTargetBranch(String targetBranch)

See Also:

• targetBranch

withSourceBranch

public GitHubPRCause withSourceBranch(String sourceBranch)

See Also:

• sourceBranch

withPrAuthorEmail

public GitHubPRCause withPrAuthorEmail(String prAuthorEmail)

See Also:

• prAuthorEmail

withSourceRepoOwner

public GitHubPRCause withSourceRepoOwner(String sourceRepoOwner)

See Also:

• sourceRepoOwner

withTriggerSenderName

public GitHubPRCause withTriggerSenderName(String triggerSenderName)

See Also:

• triggerSenderName

withTriggerSenderEmail

public GitHubPRCause withTriggerSenderEmail(String triggerSenderEmail)

See Also:

• triggerSenderEmail

withLabels

public GitHubPRCause withLabels(Set<String> labels)

See Also:

• labels

withCommitAuthorName

public GitHubPRCause withCommitAuthorName(String commitAuthorName)

See Also:

• commitAuthorName

withCommitAuthorEmail

public GitHubPRCause withCommitAuthorEmail(String commitAuthorEmail)

See Also:

• commitAuthorEmail

withCondRef

public GitHubPRCause withCondRef(String condRef)

See Also:

• condRef

withCommentAuthorName

public GitHubPRCause withCommentAuthorName(String commentAuthorName)

withCommentAuthorEmail

public GitHubPRCause withCommentAuthorEmail(String commentAuthorEmail)

withCommentBody

public GitHubPRCause withCommentBody(String commentBody)

withCommentBodyMatch

public GitHubPRCause withCommentBodyMatch(String commentBodyMatch)

getBody

public String getBody()

withBody

public GitHubPRCause withBody(String body)

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in class Cause

getHeadSha

public String getHeadSha()

isMergeable

public boolean isMergeable()

getNumber

public int getNumber()

getTargetBranch

public String getTargetBranch()

getSourceBranch

public String getSourceBranch()

getPRAuthorEmail

public String getPRAuthorEmail()

getSourceRepoOwner

public String getSourceRepoOwner()

getLabels

@NonNull
public Set<String> getLabels()

getTriggerSenderName

public String getTriggerSenderName()

getTriggerSenderEmail

public String getTriggerSenderEmail()

getPrAuthorEmail

public String getPrAuthorEmail()

getCommitAuthorName

public String getCommitAuthorName()

getCommitAuthorEmail

public String getCommitAuthorEmail()

getState

public String getState()

getCondRef

@NonNull
public String getCondRef()

getCommentAuthorName

public String getCommentAuthorName()

When trigger by comment, author of comment.

getCommentAuthorEmail

public String getCommentAuthorEmail()

When trigger by comment, author email of comment.

getCommentBody

public String getCommentBody()

When trigger by comment, body of comment.

getCommentBodyMatch

public String getCommentBodyMatch()

When trigger by comment, string matched to pattern.

fillParameters

public void fillParameters(List<ParameterValue> params)

Specified by:

fillParameters in class GitHubCause<GitHubPRCause>

createSCMHead

public GitHubSCMHead<GitHubPRCause> createSCMHead(String sourceId)

Specified by:

createSCMHead in class GitHubCause<GitHubPRCause>

onAddedTo

public void onAddedTo(@NonNull
 Run run)

Overrides:

onAddedTo in class Cause

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object