Package org.jenkinsci.plugins.github_branch_source

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>

A SCMSourceBuilder that builds GitHubSCMSource instances

Since:

2.2.0

Constructor Summary

Constructors

Constructor	Description
GitHubSCMSourceBuilder(String id, String apiUri, String credentialsId, String repoOwner, String repoName)	Constructor.

Method Summary

Modifier and Type	Method	Description
final String	apiUri()	The endpoint of the GitHubSCMSource that is being built.
GitHubSCMSource	build()
final String	credentialsId()	The credentials that the GitHubSCMSource will use.
final String	id()	The id of the GitHubSCMSource that is being built.
final String	repoOwner()	The repository owner that the GitHubSCMSource will be configured to use.

Methods inherited from class jenkins.scm.api.trait.SCMSourceBuilder

projectName, sourceClass, traits, withRequest, withTrait, withTrait, withTraits, withTraits

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GitHubSCMSourceBuilder

public GitHubSCMSourceBuilder(@CheckForNull
 String id,
 @CheckForNull
 String apiUri,
 @CheckForNull
 String credentialsId,
 @NonNull
 String repoOwner,
 @NonNull
 String repoName)

Constructor.

Parameters:

id - the SCMSource.getId()

apiUri - the GitHubSCMSource.getApiUri()

credentialsId - the credentials id.

repoOwner - the repository owner.

repoName - the project name.

Method Details

id

public final String id()

The id of the GitHubSCMSource that is being built.

Returns:

the id of the GitHubSCMSource that is being built.

apiUri

@CheckForNull
public final String apiUri()

The endpoint of the GitHubSCMSource that is being built.

Returns:

the endpoint of the GitHubSCMSource that is being built.

credentialsId

@CheckForNull
public final String credentialsId()

The credentials that the GitHubSCMSource will use.

Returns:

the credentials that the GitHubSCMSource will use.

repoOwner

@NonNull
public final String repoOwner()

The repository owner that the GitHubSCMSource 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 class jenkins.scm.api.trait.SCMSourceBuilder<GitHubSCMSourceBuilder,GitHubSCMSource>