io.jenkins.plugins.dagshubbranchsource.git

Class PullRequestSCMHead

java.lang.Object

jenkins.scm.api.SCMHead

io.jenkins.plugins.dagshubbranchsource.git.PullRequestSCMHead

All Implemented Interfaces:

Serializable, Comparable<jenkins.scm.api.SCMHead>, jenkins.scm.api.mixin.ChangeRequestSCMHead, jenkins.scm.api.mixin.ChangeRequestSCMHead2, jenkins.scm.api.mixin.SCMHeadMixin

public class PullRequestSCMHead
extends jenkins.scm.api.SCMHead
implements jenkins.scm.api.mixin.ChangeRequestSCMHead2

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class jenkins.scm.api.SCMHead

jenkins.scm.api.SCMHead.HeadByItem

Nested classes/interfaces inherited from interface jenkins.scm.api.mixin.SCMHeadMixin

jenkins.scm.api.mixin.SCMHeadMixin.Equality

Field Summary

Fields inherited from class jenkins.scm.api.SCMHead

PRONOUN

Constructor Summary

Constructors

Constructor and Description
PullRequestSCMHead(String name, long id, long number, jenkins.plugins.git.GitBranchSCMHead target, jenkins.scm.api.mixin.ChangeRequestCheckoutStrategy strategy, jenkins.scm.api.SCMHeadOrigin origin, String originOwner, String originProjectPath, String originName, String title) Constructor.

Method Summary

Modifier and Type	Method and Description
jenkins.scm.api.mixin.ChangeRequestCheckoutStrategy	getCheckoutStrategy()
String	getId()
long	getNumber()
jenkins.scm.api.SCMHeadOrigin	getOrigin()
String	getOriginName()
String	getOriginOwner()
String	getOriginProjectPath()
String	getPronoun()
jenkins.plugins.git.GitBranchSCMHead	getTarget()
String	getTitle()

Methods inherited from class jenkins.scm.api.SCMHead

compareTo, equals, getAction, getAllActions, getName, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface jenkins.scm.api.mixin.SCMHeadMixin

getName

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

PullRequestSCMHead

public PullRequestSCMHead(@NonNull
                          String name,
                          long id,
                          long number,
                          jenkins.plugins.git.GitBranchSCMHead target,
                          jenkins.scm.api.mixin.ChangeRequestCheckoutStrategy strategy,
                          jenkins.scm.api.SCMHeadOrigin origin,
                          String originOwner,
                          String originProjectPath,
                          String originName,
                          String title)

Constructor.

Parameters:

name - the name of the PR (Probably PR-XX).

id - the pull request id.

number - the index of the PR inside the origin repo (counts both issues and PRs)

target - the target of this merge request.

strategy - the checkout strategy

origin - the origin of the merge request

originOwner - the name of the owner of the origin project

originProjectPath - the name of the origin project path

originName - the name of the branch in the origin project

title - the title of the merge request

Method Detail

getPronoun

public String getPronoun()

Overrides:

getPronoun in class jenkins.scm.api.SCMHead

getCheckoutStrategy

@NonNull
public jenkins.scm.api.mixin.ChangeRequestCheckoutStrategy getCheckoutStrategy()

Specified by:

getCheckoutStrategy in interface jenkins.scm.api.mixin.ChangeRequestSCMHead2

getOriginName

@NonNull
public String getOriginName()

Specified by:

getOriginName in interface jenkins.scm.api.mixin.ChangeRequestSCMHead2

getId

@NonNull
public String getId()

Specified by:

getId in interface jenkins.scm.api.mixin.ChangeRequestSCMHead

getNumber

public long getNumber()

getTarget

@NonNull
public jenkins.plugins.git.GitBranchSCMHead getTarget()

Specified by:

getTarget in interface jenkins.scm.api.mixin.ChangeRequestSCMHead

getOrigin

@NonNull
public jenkins.scm.api.SCMHeadOrigin getOrigin()

Specified by:

getOrigin in interface jenkins.scm.api.mixin.SCMHeadMixin

Overrides:

getOrigin in class jenkins.scm.api.SCMHead

getOriginOwner

public String getOriginOwner()

getOriginProjectPath

public String getOriginProjectPath()

getTitle

public String getTitle()