Package jenkins.scm.api.mixin
Interface ChangeRequestSCMHead
-
- All Superinterfaces:
Comparable<SCMHead>
,SCMHeadMixin
,Serializable
- All Known Subinterfaces:
ChangeRequestSCMHead2
public interface ChangeRequestSCMHead extends SCMHeadMixin
Mixin interface to identifySCMHead
instances that correspond to a change request.- Since:
- 2.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface jenkins.scm.api.mixin.SCMHeadMixin
SCMHeadMixin.Equality
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getId()
Identifier of this change request.SCMHead
getTarget()
Branch to which this change would be merged or applied if it were accepted.-
Methods inherited from interface java.lang.Comparable
compareTo
-
Methods inherited from interface jenkins.scm.api.mixin.SCMHeadMixin
getName, getOrigin
-
-
-
-
Method Detail
-
getId
@Exported @NonNull String getId()
Identifier of this change request. Expected to be unique among requests coming from a givenSCMSource
.- Returns:
- an ID of some kind, such as a pull request number (decimal) or a Gerrit change ID
-
getTarget
@Exported @NonNull SCMHead getTarget()
Branch to which this change would be merged or applied if it were accepted.- Returns:
- a "target" or "base" branch
-
-