Package com.atlassian.bamboo.specs.api.builders.plan.branches

Class BranchIntegration

java.lang.Object

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

com.atlassian.bamboo.specs.api.builders.plan.branches.BranchIntegration

public class BranchIntegration
extends EntityPropertiesBuilder<BranchIntegrationProperties>

Represents branch merging strategy.

Constructor Summary

Constructors

Constructor	Description
BranchIntegration()

Method Summary

Modifier and Type	Method	Description
protected BranchIntegrationProperties	build()
BranchIntegration	enabled(boolean enabled)	Enables/disables automatic branch merging.
BranchIntegration	gatekeeper(boolean gatekeeper)	Selects merging strategy.
BranchIntegration	integrationBranch(@NotNull PlanBranchIdentifier integrationBranch)	Sets integration branch identifier.
BranchIntegration	integrationBranchKey(@NotNull BambooKey integrationBranchKey)	Sets integration branch key.
BranchIntegration	integrationBranchKey(@NotNull java.lang.String integrationBranchKey)	Sets integration branch key.
BranchIntegration	integrationBranchOid(@NotNull BambooOid integrationBranchOid)	Sets integration branch oid.
BranchIntegration	integrationBranchOid(@NotNull java.lang.String integrationBranchOid)	Sets integration branch oid.
BranchIntegration	pushOnSuccessfulBuild(boolean push)	Enables/disables executing push on successful build.

Methods inherited from class java.lang.Object

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

Constructor Detail

BranchIntegration

public BranchIntegration()

Method Detail

enabled

public BranchIntegration enabled(boolean enabled)
                          throws PropertiesValidationException

Enables/disables automatic branch merging. Enabled by default.

Throws:

PropertiesValidationException

integrationBranchOid

public BranchIntegration integrationBranchOid(@NotNull
                                              @NotNull java.lang.String integrationBranchOid)
                                       throws PropertiesValidationException

Sets integration branch oid.

If both oid and key is defined, key is ignored.

Throws:

PropertiesValidationException

integrationBranchOid

public BranchIntegration integrationBranchOid(@NotNull
                                              @NotNull BambooOid integrationBranchOid)
                                       throws PropertiesValidationException

Sets integration branch oid.

If both oid and key is defined, key is ignored.

Throws:

PropertiesValidationException

integrationBranchKey

public BranchIntegration integrationBranchKey(@NotNull
                                              @NotNull java.lang.String integrationBranchKey)
                                       throws PropertiesValidationException

Sets integration branch key.

If both oid and key is defined, key is ignored.

Throws:

PropertiesValidationException

integrationBranchKey

public BranchIntegration integrationBranchKey(@NotNull
                                              @NotNull BambooKey integrationBranchKey)
                                       throws PropertiesValidationException

Sets integration branch key.

If both oid and key is defined, key is ignored.

Throws:

PropertiesValidationException

integrationBranch

public BranchIntegration integrationBranch(@NotNull
                                           @NotNull PlanBranchIdentifier integrationBranch)
                                    throws PropertiesValidationException

Sets integration branch identifier.

If both oid and key is defined by the identifier, key is ignored.

Throws:

PropertiesValidationException

gatekeeper

public BranchIntegration gatekeeper(boolean gatekeeper)
                             throws PropertiesValidationException

Selects merging strategy. If true, the integration branch is the target branch of the merge and, possibly, the push. If false, the integration branch is the source branch of the merge, and current branch is the target.

Default is false (current branch is the target of the merge).

Throws:

PropertiesValidationException

pushOnSuccessfulBuild

public BranchIntegration pushOnSuccessfulBuild(boolean push)
                                        throws PropertiesValidationException

Enables/disables executing push on successful build. The target branch is selected by setting gatekeeper(boolean) option. Feature is turned off by default.

Throws:

PropertiesValidationException

build

protected BranchIntegrationProperties build()
                                     throws PropertiesValidationException

Specified by:

build in class EntityPropertiesBuilder<BranchIntegrationProperties>

Throws:

PropertiesValidationException