Package com.atlassian.bamboo.specs.builders.repository.bitbucket.cloud

Class BitbucketCloudRepository

java.lang.Object

com.atlassian.bamboo.specs.api.builders.EntityPropertiesBuilder<T>

com.atlassian.bamboo.specs.api.builders.RootEntityPropertiesBuilder<E>

com.atlassian.bamboo.specs.api.builders.repository.VcsRepository<BitbucketCloudRepository,BitbucketCloudRepositoryProperties>

com.atlassian.bamboo.specs.builders.repository.bitbucket.cloud.BitbucketCloudRepository

public class BitbucketCloudRepository
extends VcsRepository<BitbucketCloudRepository,BitbucketCloudRepositoryProperties>

Represents Bitbucket Cloud repository in Bamboo.

Field Summary

Fields inherited from class com.atlassian.bamboo.specs.api.builders.repository.VcsRepository

description, name, oid, parent, project, repositoryViewer, TYPE

Constructor Summary

Constructors

Constructor	Description
BitbucketCloudRepository()

Method Summary

Modifier and Type	Method	Description
BitbucketCloudRepository	accountAuthentication(@NotNull SharedCredentialsIdentifier sharedCredentialsIdentifier)	Selects a previously defined SharedCredentials to configure account authentication with bitbucket.org
BitbucketCloudRepository	accountAuthentication(@NotNull EmailApiTokenAuthentication emailApiTokenAuthentication)	Specifies email/API token Bitbucket Cloud account authentication.
BitbucketCloudRepository	accountAuthentication(@NotNull UserPasswordAuthentication userPasswordAuthentication)	Deprecated. since 9.6.16, use accountAuthentication(EmailApiTokenAuthentication)
BitbucketCloudRepository	branch(@NotNull String branch)	Sets a branch to check out.
protected BitbucketCloudRepositoryProperties	build()
BitbucketCloudRepository	changeDetection(VcsChangeDetection vcsChangeDetection)	Sets change detection options for this repository.
BitbucketCloudRepository	checkoutAuthentication(@NotNull SharedCredentialsIdentifier sharedCredentialsIdentifier)	Selects a previously defined SharedCredentials which will be used to checkout repository from Bitbucket Cloud.
BitbucketCloudRepository	checkoutAuthentication(@NotNull SshPrivateKeyAuthentication sshPrivateKeyAuthentication)	Specifies SSH private key which will be used to checkout repository from Bitbucket Cloud.
BitbucketCloudRepository	commandTimeout(Duration commandTimeout)	Specifies how much time is given for git commands to finish.
BitbucketCloudRepository	commandTimeoutInMinutes(int commandTimeoutMinutes)	Specifies how much time in minutes is given for git commands to finish.
BitbucketCloudRepository	defaultChangeDetection()	Resets all change detection options to defaults.
BitbucketCloudRepository	fetchWholeRepository(boolean fetchWholeRepository)	Enforces (or not) fetching all remote refs from the repository rather than single branch.
BitbucketCloudRepository	lfsEnabled(boolean useLfs)	Enables/disables git lfs support.
BitbucketCloudRepository	remoteAgentCacheEnabled(boolean useRemoteAgentCache)	Enables/disables caching repository content on the remote and elastic agents.
BitbucketCloudRepository	repositorySlug(@NotNull String owner, @NotNull String repositorySlug)	Sets the Bitbucket repository slug to checkout.
BitbucketCloudRepository	shallowClonesEnabled(boolean useShallowClones)	Enables/disables shallow clones when checking out from the repository.
BitbucketCloudRepository	sshKeyAppliesToSubmodules(boolean sshKeyAppliesToSubmodules)	Enables/disabled authenticating to submodules with SSH key configured for this repository.
BitbucketCloudRepository	submodulesEnabled(boolean useSubmodules)	Enables/disables submodule support.
BitbucketCloudRepository	submodulesUseShallowClonesEnabled(boolean useSubmodulesWithShallowClones)	Enables/disables shallow clone support for submodules.
BitbucketCloudRepository	verboseLogs(boolean verboseLogs)	Enables/disables verbose logs from git commands.
BitbucketCloudRepository	webhookEnabled(boolean webhookEnabled)	Enables webhooks support for the repository.

Methods inherited from class com.atlassian.bamboo.specs.api.builders.repository.VcsRepository

description, getIdentifier, getName, getOid, humanReadableId, humanReadableType, name, oid, oid, parent, project, repositoryViewer

Methods inherited from class java.lang.Object

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

Constructor Details

BitbucketCloudRepository

public BitbucketCloudRepository()
                         throws PropertiesValidationException

Throws:

PropertiesValidationException

Method Details

repositorySlug

public BitbucketCloudRepository repositorySlug(@NotNull
 @NotNull String owner,
 @NotNull
 @NotNull String repositorySlug)

Sets the Bitbucket repository slug to checkout. A repository slug is a URL-friendly version of a repository name, automatically generated by Bitbucket Cloud for use in the URL.

This field is required and it must represents existing Bitbucket Cloud repository.

branch

public BitbucketCloudRepository branch(@NotNull
 @NotNull String branch)

Sets a branch to check out. This field is required.

shallowClonesEnabled

public BitbucketCloudRepository shallowClonesEnabled(boolean useShallowClones)

Enables/disables shallow clones when checking out from the repository. With shallow clones on, Bamboo fetches the shallowest commit history possible. Do not use if your build depends on full repository history.

Shallow clones are switched off by default.

Option does nothing with Mercurial type of repository.

sshKeyAppliesToSubmodules

public BitbucketCloudRepository sshKeyAppliesToSubmodules(boolean sshKeyAppliesToSubmodules)

Enables/disabled authenticating to submodules with SSH key configured for this repository.

submodulesEnabled

public BitbucketCloudRepository submodulesEnabled(boolean useSubmodules)

Enables/disables submodule support. Turned off by default.

submodulesUseShallowClonesEnabled

public BitbucketCloudRepository submodulesUseShallowClonesEnabled(boolean useSubmodulesWithShallowClones)

Enables/disables shallow clone support for submodules. Turned off by default.

remoteAgentCacheEnabled

public BitbucketCloudRepository remoteAgentCacheEnabled(boolean useRemoteAgentCache)

Enables/disables caching repository content on the remote and elastic agents. Bamboo uses caching to reduce bandwidth needed when retrieving source code from the repository.

The feature is turned on by default in Git repositories

Option does nothing with Mercurial type of repository.

commandTimeout

public BitbucketCloudRepository commandTimeout(Duration commandTimeout)

Specifies how much time is given for git commands to finish. Default is 180 minutes.

commandTimeoutInMinutes

public BitbucketCloudRepository commandTimeoutInMinutes(int commandTimeoutMinutes)

Specifies how much time in minutes is given for git commands to finish. Default is 180 minutes.

verboseLogs

public BitbucketCloudRepository verboseLogs(boolean verboseLogs)

Enables/disables verbose logs from git commands. Off by default.

fetchWholeRepository

public BitbucketCloudRepository fetchWholeRepository(boolean fetchWholeRepository)

Enforces (or not) fetching all remote refs from the repository rather than single branch. Off by default.

lfsEnabled

public BitbucketCloudRepository lfsEnabled(boolean useLfs)

Enables/disables git lfs support. Off by default.

Option does nothing with Mercurial type of repository.

webhookEnabled

public BitbucketCloudRepository webhookEnabled(boolean webhookEnabled)

Enables webhooks support for the repository. Off by default.

defaultChangeDetection

public BitbucketCloudRepository defaultChangeDetection()

Resets all change detection options to defaults.

changeDetection

public BitbucketCloudRepository changeDetection(VcsChangeDetection vcsChangeDetection)

Sets change detection options for this repository.

See Also:

• VcsChangeDetection

accountAuthentication

public BitbucketCloudRepository accountAuthentication(@NotNull
 @NotNull SharedCredentialsIdentifier sharedCredentialsIdentifier)

Selects a previously defined SharedCredentials to configure account authentication with bitbucket.org

Currently, only username/password credentials are supported.

accountAuthentication

@Deprecated
public BitbucketCloudRepository accountAuthentication(@NotNull
 @NotNull UserPasswordAuthentication userPasswordAuthentication)

Deprecated.

since 9.6.16, use accountAuthentication(EmailApiTokenAuthentication)

Specifies username/password Bitbucket Cloud account authentication.

The password can be defined in both Bamboo-encrypted and plain format.

See Also:

• Encryption in Bamboo Specs
• App passwords deprecation notice

accountAuthentication

public BitbucketCloudRepository accountAuthentication(@NotNull
 @NotNull EmailApiTokenAuthentication emailApiTokenAuthentication)

Specifies email/API token Bitbucket Cloud account authentication.

The API token can be defined in both Bamboo-encrypted and plain format.

See Also:

• Using API tokens in Bitbucket Cloud
• Encryption in Bamboo Specs

checkoutAuthentication

public BitbucketCloudRepository checkoutAuthentication(@NotNull
 @NotNull SharedCredentialsIdentifier sharedCredentialsIdentifier)

Selects a previously defined SharedCredentials which will be used to checkout repository from Bitbucket Cloud. Currently SSH credentials are supported.

If checkout authentication is not configured, the accountAuthentication will be used.

checkoutAuthentication

public BitbucketCloudRepository checkoutAuthentication(@NotNull
 @NotNull SshPrivateKeyAuthentication sshPrivateKeyAuthentication)

Specifies SSH private key which will be used to checkout repository from Bitbucket Cloud. If checkout authentication is not configured, the accountAuthentication will be used.

The key and passphrase can be defined in both Bamboo-encrypted and plain format.

See Also:

• Encryption in Bamboo Specs

build

protected BitbucketCloudRepositoryProperties build()
                                            throws PropertiesValidationException

Specified by:

build in class VcsRepository<BitbucketCloudRepository,BitbucketCloudRepositoryProperties>

Throws:

PropertiesValidationException