public class GitHubSCMNavigator
extends jenkins.scm.api.SCMNavigator
Modifier and Type | Class and Description |
---|---|
static class |
GitHubSCMNavigator.DescriptorImpl |
Constructor and Description |
---|
GitHubSCMNavigator(String repoOwner)
Constructor.
|
GitHubSCMNavigator(String apiUri,
String repoOwner,
String scanCredentialsId,
String checkoutCredentialsId)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
afterSave(jenkins.scm.api.SCMNavigatorOwner owner) |
String |
getApiUri()
Gets the API endpoint for the GitHub server.
|
boolean |
getBuildForkPRHead()
Deprecated.
|
boolean |
getBuildForkPRMerge()
Deprecated.
|
boolean |
getBuildOriginBranch()
Deprecated.
|
boolean |
getBuildOriginBranchWithPR()
Deprecated.
|
boolean |
getBuildOriginPRHead()
Deprecated.
|
boolean |
getBuildOriginPRMerge()
Deprecated.
|
String |
getCheckoutCredentialsId()
Deprecated.
use
SSHCheckoutTrait |
String |
getCredentialsId()
Gets the
IdCredentials.getId() of the credentials to use when accessing apiUri (and also
the default credentials to use for checking out). |
String |
getExcludes()
Deprecated.
use
WildcardSCMHeadFilterTrait . |
String |
getIncludes()
Deprecated.
use
WildcardSCMHeadFilterTrait . |
String |
getPattern()
Deprecated.
use
RegexSCMSourceFilterTrait |
String |
getRepoOwner()
Gets the name of the owner who's repositories will be navigated.
|
String |
getScanCredentialsId()
Deprecated.
use
getCredentialsId() . |
List<jenkins.scm.api.trait.SCMTrait<? extends jenkins.scm.api.trait.SCMTrait<?>>> |
getTraits()
Gets the behavioural traits that are applied to this navigator and any
GitHubSCMSource instances it
discovers. |
protected String |
id() |
List<hudson.model.Action> |
retrieveActions(jenkins.scm.api.SCMNavigatorOwner owner,
jenkins.scm.api.SCMNavigatorEvent event,
hudson.model.TaskListener listener) |
void |
setApiUri(String apiUri)
Sets the API endpoint for the GitHub server.
|
void |
setBuildForkPRHead(boolean buildForkPRHead)
Deprecated.
|
void |
setBuildForkPRMerge(boolean buildForkPRMerge)
Deprecated.
|
void |
setBuildOriginBranch(boolean buildOriginBranch)
Deprecated.
|
void |
setBuildOriginBranchWithPR(boolean buildOriginBranchWithPR)
Deprecated.
|
void |
setBuildOriginPRHead(boolean buildOriginPRHead)
Deprecated.
|
void |
setBuildOriginPRMerge(boolean buildOriginPRMerge)
Deprecated.
|
void |
setCredentialsId(String credentialsId)
Sets the
IdCredentials.getId() of the credentials to use when accessing apiUri (and also
the default credentials to use for checking out). |
void |
setExcludes(String excludes)
Deprecated.
use
WildcardSCMHeadFilterTrait . |
void |
setIncludes(String includes)
Deprecated.
use
WildcardSCMHeadFilterTrait . |
void |
setPattern(String pattern)
Deprecated.
use
RegexSCMSourceFilterTrait |
void |
setScanCredentialsId(String scanCredentialsId)
Deprecated.
|
void |
setTraits(List<jenkins.scm.api.trait.SCMTrait<? extends jenkins.scm.api.trait.SCMTrait<?>>> traits)
Sets the behavioural traits that are applied to this navigator and any
GitHubSCMSource instances it
discovers. |
void |
setTraits(jenkins.scm.api.trait.SCMTrait[] traits)
Sets the behavioural traits that are applied to this navigator and any
GitHubSCMSource instances it
discovers. |
void |
visitSource(String sourceName,
jenkins.scm.api.SCMSourceObserver observer) |
void |
visitSources(jenkins.scm.api.SCMSourceObserver observer) |
@DataBoundConstructor public GitHubSCMNavigator(String repoOwner)
repoOwner
- the owner of the repositories to navigate.@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") public GitHubSCMNavigator(String apiUri, String repoOwner, String scanCredentialsId, String checkoutCredentialsId)
GitHubSCMNavigator(String)
, setApiUri(String)
,
setCredentialsId(String)
and SSHCheckoutTrait
apiUri
- the API endpoint for the GitHub server.repoOwner
- the owner of the repositories to navigate.scanCredentialsId
- the credentials to use when accessing apiUri
(and also the default
credentials to use for checking out).checkoutCredentialsId
- the credentials to use when checking out.@CheckForNull public String getApiUri()
@DataBoundSetter public void setApiUri(String apiUri)
apiUri
- the API endpoint for the GitHub server.@CheckForNull public String getCredentialsId()
IdCredentials.getId()
of the credentials to use when accessing apiUri
(and also
the default credentials to use for checking out).IdCredentials.getId()
of the credentials to use when accessing apiUri
(and
also the default credentials to use for checking out).@DataBoundSetter public void setCredentialsId(@CheckForNull String credentialsId)
IdCredentials.getId()
of the credentials to use when accessing apiUri
(and also
the default credentials to use for checking out).credentialsId
- the IdCredentials.getId()
of the credentials to use when accessing
apiUri
(and also the default credentials to use for checking out).@NonNull public String getRepoOwner()
@NonNull public List<jenkins.scm.api.trait.SCMTrait<? extends jenkins.scm.api.trait.SCMTrait<?>>> getTraits()
GitHubSCMSource
instances it
discovers.getTraits
in class jenkins.scm.api.SCMNavigator
@DataBoundSetter public void setTraits(@CheckForNull jenkins.scm.api.trait.SCMTrait[] traits)
GitHubSCMSource
instances it
discovers. The new traits will take affect on the next navigation through any of the
visitSources(SCMSourceObserver)
overloads or visitSource(String, SCMSourceObserver)
.traits
- the new behavioural traits.public void setTraits(@CheckForNull List<jenkins.scm.api.trait.SCMTrait<? extends jenkins.scm.api.trait.SCMTrait<?>>> traits)
GitHubSCMSource
instances it
discovers. The new traits will take affect on the next navigation through any of the
visitSources(SCMSourceObserver)
overloads or visitSource(String, SCMSourceObserver)
.setTraits
in class jenkins.scm.api.SCMNavigator
traits
- the new behavioural traits.@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") @CheckForNull public String getScanCredentialsId()
getCredentialsId()
.getCredentialsId()
.@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") @DataBoundSetter public void setScanCredentialsId(@CheckForNull String scanCredentialsId)
setCredentialsId(String)
scanCredentialsId
- the credentials.@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") @NonNull public String getIncludes()
WildcardSCMHeadFilterTrait
.WildcardSCMHeadFilterTrait.getIncludes()
@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") @NonNull public String getExcludes()
WildcardSCMHeadFilterTrait
.WildcardSCMHeadFilterTrait.getExcludes()
@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") @DataBoundSetter public void setIncludes(@NonNull String includes)
WildcardSCMHeadFilterTrait
.includes
- see WildcardSCMHeadFilterTrait.WildcardSCMHeadFilterTrait(String, String)
@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class) @RestrictedSince(value="2.2.0") @DataBoundSetter public void setExcludes(@NonNull String excludes)
WildcardSCMHeadFilterTrait
.excludes
- see WildcardSCMHeadFilterTrait.WildcardSCMHeadFilterTrait(String, String)
@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") public boolean getBuildOriginBranch()
BranchDiscoveryTrait
BranchDiscoveryTrait.isBuildBranch()
.@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") @DataBoundSetter public void setBuildOriginBranch(boolean buildOriginBranch)
BranchDiscoveryTrait
buildOriginBranch
- see BranchDiscoveryTrait.BranchDiscoveryTrait(boolean, boolean)
.@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") public boolean getBuildOriginBranchWithPR()
BranchDiscoveryTrait
@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") @DataBoundSetter public void setBuildOriginBranchWithPR(boolean buildOriginBranchWithPR)
BranchDiscoveryTrait
buildOriginBranchWithPR
- see BranchDiscoveryTrait.BranchDiscoveryTrait(boolean, boolean)
.@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") public boolean getBuildOriginPRMerge()
OriginPullRequestDiscoveryTrait.getStrategies()
@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") @DataBoundSetter public void setBuildOriginPRMerge(boolean buildOriginPRMerge)
OriginPullRequestDiscoveryTrait
buildOriginPRMerge
- see OriginPullRequestDiscoveryTrait.OriginPullRequestDiscoveryTrait(Set)
.@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") public boolean getBuildOriginPRHead()
OriginPullRequestDiscoveryTrait.getStrategies()
@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") @DataBoundSetter public void setBuildOriginPRHead(boolean buildOriginPRHead)
OriginPullRequestDiscoveryTrait
buildOriginPRHead
- see OriginPullRequestDiscoveryTrait.OriginPullRequestDiscoveryTrait(Set)
.@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") public boolean getBuildForkPRMerge()
ForkPullRequestDiscoveryTrait.getStrategies()
@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") @DataBoundSetter public void setBuildForkPRMerge(boolean buildForkPRMerge)
ForkPullRequestDiscoveryTrait
buildForkPRMerge
- see ForkPullRequestDiscoveryTrait.ForkPullRequestDiscoveryTrait(Set, SCMHeadAuthority)
.@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") public boolean getBuildForkPRHead()
ForkPullRequestDiscoveryTrait.getStrategies()
@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") @DataBoundSetter public void setBuildForkPRHead(boolean buildForkPRHead)
ForkPullRequestDiscoveryTrait
buildForkPRHead
- see
ForkPullRequestDiscoveryTrait.ForkPullRequestDiscoveryTrait(Set, SCMHeadAuthority)
.@CheckForNull @Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") public String getCheckoutCredentialsId()
SSHCheckoutTrait
SSHCheckoutTrait.getCredentialsId()
with some mangling to preserve legacy behaviour.@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") public String getPattern()
RegexSCMSourceFilterTrait
RegexSCMSourceFilterTrait.getRegex()
.@Deprecated @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince(value="2.2.0") @DataBoundSetter public void setPattern(String pattern)
RegexSCMSourceFilterTrait
pattern
- see RegexSCMSourceFilterTrait.RegexSCMSourceFilterTrait(String)
.@NonNull protected String id()
id
in class jenkins.scm.api.SCMNavigator
public void visitSources(jenkins.scm.api.SCMSourceObserver observer) throws IOException, InterruptedException
visitSources
in class jenkins.scm.api.SCMNavigator
IOException
InterruptedException
public void visitSource(String sourceName, jenkins.scm.api.SCMSourceObserver observer) throws IOException, InterruptedException
visitSource
in class jenkins.scm.api.SCMNavigator
IOException
InterruptedException
@NonNull public List<hudson.model.Action> retrieveActions(@NonNull jenkins.scm.api.SCMNavigatorOwner owner, @CheckForNull jenkins.scm.api.SCMNavigatorEvent event, @NonNull hudson.model.TaskListener listener) throws IOException, InterruptedException
retrieveActions
in class jenkins.scm.api.SCMNavigator
IOException
InterruptedException
public void afterSave(@NonNull jenkins.scm.api.SCMNavigatorOwner owner)
afterSave
in class jenkins.scm.api.SCMNavigator
Copyright © 2016–2020. All rights reserved.