Class VcsRepositoryBranch
- java.lang.Object
-
- com.atlassian.bamboo.specs.api.builders.EntityPropertiesBuilder<VcsRepositoryBranchProperties>
-
- com.atlassian.bamboo.specs.api.builders.repository.VcsRepositoryBranch
-
public class VcsRepositoryBranch extends EntityPropertiesBuilder<VcsRepositoryBranchProperties>
Defines a branch a repository should be switched to.
-
-
Constructor Summary
Constructors Constructor Description VcsRepositoryBranch(@NotNull String repositoryName, @NotNull String branchName)Defines a branch a repository should be switched to.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VcsRepositoryBranchbranchDisplayName(@NotNull String branchDisplayName)Specifies display name for the branch.VcsRepositoryBranchbranchName(@NotNull String branchName)Specifies a branch.protected VcsRepositoryBranchPropertiesbuild()
-
-
-
Constructor Detail
-
VcsRepositoryBranch
public VcsRepositoryBranch(@NotNull @NotNull String repositoryName, @NotNull @NotNull String branchName)Defines a branch a repository should be switched to. The repository has to be connected to the plan: seePlan.linkedRepositories(String...)andPlan.planRepositories(VcsRepository[])- Parameters:
repositoryName- name of the repositorybranchName- name of the branch
-
-
Method Detail
-
branchName
public VcsRepositoryBranch branchName(@NotNull @NotNull String branchName)
Specifies a branch.
-
branchDisplayName
public VcsRepositoryBranch branchDisplayName(@NotNull @NotNull String branchDisplayName)
Specifies display name for the branch. By default, it is equal to the branch name and does not need to be specified.Some vcs configurations can result in branch name being relatively long. For instance, in case of Subversion, branch name contains a relative path of the branch. In such cases showing full branch name in the UI is not practical, hence the separate parameter for the display name.
-
build
protected VcsRepositoryBranchProperties build() throws PropertiesValidationException
- Specified by:
buildin classEntityPropertiesBuilder<VcsRepositoryBranchProperties>- Throws:
PropertiesValidationException
-
-