com.atlassian.bamboo.v2.build

Interface BuildIdentifier

All Superinterfaces:

Serializable

All Known Subinterfaces:

BuildContext

All Known Implementing Classes:

BuildContextImpl, BuildIdentifierImpl, DeploymentRepositoryBuildContext

public interface BuildIdentifier
extends Serializable

Method Summary

Modifier and Type	Method and Description
int	getBuildNumber() The build number being built
String	getBuildResultKey() Deprecated. since 6.0 use getPlanResultKey() instead
Optional<Long>	getMasterPlanId()
BuildIdentifier	getParentBuildIdentifier()
Optional<Long>	getPlanDbId()
long	getPlanId() Deprecated. since 6.9 use getPlanDbId()
String	getPlanKey() Deprecated. since 5.11, use getTypedPlanKey() instead
String	getPlanName() The full name of the Plan
PlanResultKey	getPlanResultKey() Gets the PlanResultKey for the current BuildIdentifier
String	getProjectName()
String	getShortName() The short name of the Plan
PlanKey	getTypedPlanKey() Full plan key (e.g.

Method Detail

getParentBuildIdentifier

@Nullable
BuildIdentifier getParentBuildIdentifier()

Returns:

the BuildContext of the parent Plan execution. Should return null if the current BuildContext is for a Chain

getPlanId

@Deprecated
long getPlanId()

Deprecated. since 6.9 use getPlanDbId()

Returns:

Database id of the plan.

Throws:

IllegalStateException - if N/A

getPlanDbId

Optional<Long> getPlanDbId()

Returns:

Id of the plan or empty if N/A.

getMasterPlanId

Optional<Long> getMasterPlanId()

Returns:

id of the master plan or empty if plan has no master.

getPlanKey

@NotNull
 @Deprecated
String getPlanKey()

Deprecated. since 5.11, use getTypedPlanKey() instead

Full plan key (e.g. BAM-MAIN)

Returns:

Key for the plan BAM-MAIN

getTypedPlanKey

@NotNull
PlanKey getTypedPlanKey()

Full plan key (e.g. BAM-MAIN)

Returns:

Key for the plan BAM-MAIN

getPlanName

@NotNull
String getPlanName()

The full name of the Plan

Returns:

DescriptionProvider.getName()

getShortName

@NotNull
String getShortName()

The short name of the Plan

Returns:

PlanIdentifier.getBuildName()

getBuildNumber

int getBuildNumber()

The build number being built

Returns:

int

getBuildResultKey

@NotNull
 @Deprecated
String getBuildResultKey()

Deprecated. since 6.0 use getPlanResultKey() instead

Full build result key (e.g. BAM-MAIN-100)

Returns:

Key for build result

getPlanResultKey

@NotNull
PlanResultKey getPlanResultKey()

Gets the PlanResultKey for the current BuildIdentifier

Returns:

planResultKey

getProjectName

@NotNull
String getProjectName()