Class GitHubSCMSourceBuilder
- java.lang.Object
-
- jenkins.scm.api.trait.SCMSourceBuilder<GitHubSCMSourceBuilder,GitHubSCMSource>
-
- org.jenkinsci.plugins.github_branch_source.GitHubSCMSourceBuilder
-
public class GitHubSCMSourceBuilder extends jenkins.scm.api.trait.SCMSourceBuilder<GitHubSCMSourceBuilder,GitHubSCMSource>
ASCMSourceBuilder
that buildsGitHubSCMSource
instances- Since:
- 2.2.0
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
apiUri()
The endpoint of theGitHubSCMSource
that is being built.GitHubSCMSource
build()
String
credentialsId()
The credentials that theGitHubSCMSource
will use.String
id()
The id of theGitHubSCMSource
that is being built.String
repoOwner()
The repository owner that theGitHubSCMSource
will be configured to use.
-
-
-
Constructor Detail
-
GitHubSCMSourceBuilder
public GitHubSCMSourceBuilder(@CheckForNull String id, @CheckForNull String apiUri, @CheckForNull String credentialsId, @NonNull String repoOwner, @NonNull String repoName)
Constructor.- Parameters:
id
- theSCMSource.getId()
apiUri
- theGitHubSCMSource.getApiUri()
credentialsId
- the credentials id.repoOwner
- the repository owner.repoName
- the project name.
-
-
Method Detail
-
id
public final String id()
The id of theGitHubSCMSource
that is being built.- Returns:
- the id of the
GitHubSCMSource
that is being built.
-
apiUri
@CheckForNull public final String apiUri()
The endpoint of theGitHubSCMSource
that is being built.- Returns:
- the endpoint of the
GitHubSCMSource
that is being built.
-
credentialsId
@CheckForNull public final String credentialsId()
The credentials that theGitHubSCMSource
will use.- Returns:
- the credentials that the
GitHubSCMSource
will use.
-
repoOwner
@NonNull public final String repoOwner()
The repository owner that theGitHubSCMSource
will be configured to use.- Returns:
- the repository owner that the
GitHubSCMSource
will be configured to use.
-
build
@NonNull public GitHubSCMSource build()
- Specified by:
build
in classjenkins.scm.api.trait.SCMSourceBuilder<GitHubSCMSourceBuilder,GitHubSCMSource>
-
-