Package com.cloudbees.jenkins.plugins.bitbucket

Class BitbucketSCMSourceBuilder

java.lang.Object

jenkins.scm.api.trait.SCMSourceBuilder<BitbucketSCMSourceBuilder,BitbucketSCMSource>

com.cloudbees.jenkins.plugins.bitbucket.BitbucketSCMSourceBuilder

public class BitbucketSCMSourceBuilder
extends jenkins.scm.api.trait.SCMSourceBuilder<BitbucketSCMSourceBuilder,BitbucketSCMSource>

A SCMSourceBuilder that builds BitbucketSCMSource instances

Since:

2.2.0

Constructor Summary

Constructors

Constructor	Description
BitbucketSCMSourceBuilder(String id, String serverUrl, String credentialsId, String repoOwner, String repoName)	Deprecated. Added only for backward compatibility with BitbucketPipelineCreateRequest from Blue Ocean.
BitbucketSCMSourceBuilder(String id, String serverUrl, String credentialsId, String repoOwner, String repoName, String mirrorId)	Constructor.

Method Summary

Modifier and Type	Method	Description
BitbucketSCMSource	build()
final String	credentialsId()	The credentials that the BitbucketSCMSource will use.
final String	id()	The id of the BitbucketSCMSource that is being built.
final String	mirrorId()	The mirror id that the BitbucketSCMSource will use.
final String	repoOwner()	The repository owner that the BitbucketSCMSource will be configured to use.
final String	serverUrl()	The server url of the BitbucketSCMSource that is being built.

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

BitbucketSCMSourceBuilder

public BitbucketSCMSourceBuilder(@CheckForNull
 String id,
 @NonNull
 String serverUrl,
 @CheckForNull
 String credentialsId,
 @NonNull
 String repoOwner,
 @NonNull
 String repoName,
 @CheckForNull
 String mirrorId)

Constructor.

Parameters:

id - the SCMSource.getId()

serverUrl - the BitbucketSCMSource.getServerUrl()

credentialsId - the credentials id.

repoOwner - the repository owner.

repoName - the project name.

BitbucketSCMSourceBuilder

@Deprecated
public BitbucketSCMSourceBuilder(@CheckForNull
 String id,
 @NonNull
 String serverUrl,
 @CheckForNull
 String credentialsId,
 @NonNull
 String repoOwner,
 @NonNull
 String repoName)

Deprecated.

Added only for backward compatibility with BitbucketPipelineCreateRequest from Blue Ocean. Will be removed soon.

Backward compatible constructor.

Parameters:

id - the SCMSource.getId()

serverUrl - the BitbucketSCMSource.getServerUrl()

credentialsId - the credentials id.

repoOwner - the repository owner.

repoName - the project name.

Method Details

id

@CheckForNull
public final String id()

The id of the BitbucketSCMSource that is being built.

Returns:

the id of the BitbucketSCMSource that is being built.

serverUrl

@NonNull
public final String serverUrl()

The server url of the BitbucketSCMSource that is being built.

Returns:

the server url of the BitbucketSCMSource that is being built.

mirrorId

@CheckForNull
public final String mirrorId()

The mirror id that the BitbucketSCMSource will use.

Returns:

the mirror id that the BitbucketSCMSource will use.

credentialsId

@CheckForNull
public final String credentialsId()

The credentials that the BitbucketSCMSource will use.

Returns:

the credentials that the BitbucketSCMSource will use.

repoOwner

@NonNull
public final String repoOwner()

The repository owner that the BitbucketSCMSource will be configured to use.

Returns:

the repository owner that the BitbucketSCMSource will be configured to use.

build

@NonNull
public BitbucketSCMSource build()

Specified by:

build in class jenkins.scm.api.trait.SCMSourceBuilder<BitbucketSCMSourceBuilder,BitbucketSCMSource>