Class SSHCheckoutTrait
- java.lang.Object
-
- hudson.model.AbstractDescribableImpl<T>
-
- jenkins.scm.api.trait.SCMTrait<jenkins.scm.api.trait.SCMSourceTrait>
-
- jenkins.scm.api.trait.SCMSourceTrait
-
- org.jenkinsci.plugins.github_branch_source.SSHCheckoutTrait
-
- All Implemented Interfaces:
ExtensionPoint
,Describable<jenkins.scm.api.trait.SCMSourceTrait>
public class SSHCheckoutTrait extends jenkins.scm.api.trait.SCMSourceTrait
ASCMSourceTrait
forGitHubSCMSource
that causes theGitSCM
checkout to be performed using a SSH private key rather than the GitHub username password credentials used for scanning / indexing.- Since:
- 2.2.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SSHCheckoutTrait.DescriptorImpl
Our descriptor.-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description SSHCheckoutTrait(String credentialsId)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
decorateBuilder(jenkins.scm.api.trait.SCMBuilder<?,?> builder)
String
getCredentialsId()
Returns the configured credentials id.
-
-
-
Constructor Detail
-
SSHCheckoutTrait
@DataBoundConstructor public SSHCheckoutTrait(@CheckForNull String credentialsId)
Constructor.- Parameters:
credentialsId
- theIdCredentials.getId()
of the credentials to use orGitHubSCMSource.DescriptorImpl.ANONYMOUS
to defer to the agent configured credentials (typically anonymous but not always)
-
-
Method Detail
-
getCredentialsId
@CheckForNull public final String getCredentialsId()
Returns the configured credentials id.- Returns:
- the configured credentials id or
null
to use the build agent's key.
-
decorateBuilder
protected void decorateBuilder(jenkins.scm.api.trait.SCMBuilder<?,?> builder)
- Overrides:
decorateBuilder
in classjenkins.scm.api.trait.SCMSourceTrait
-
-