com.atlassian.bamboo.v2.build

Interface BuildIdentifier

All Superinterfaces:

Serializable

All Known Subinterfaces:

BuildContext

public interface BuildIdentifier
extends Serializable

Method Summary

Methods

Modifier and Type	Method and Description
int	getBuildNumber() The build number being built
String	getBuildResultKey() Full build result key (e.g.
BuildIdentifier	getParentBuildIdentifier()
long	getPlanId()
String	getPlanKey() Full plan key (e.g.
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

Method Detail

getParentBuildIdentifier

@Nullable
BuildIdentifier getParentBuildIdentifier()

Returns:

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

getPlanId

long getPlanId()

Returns:

Id of the plan.

getPlanKey

@NotNull
String getPlanKey()

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

Returns:

Key for the plan BAM-MAIN @NotNull

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
String getBuildResultKey()

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

Returns:

Key for build result @NotNull

getPlanResultKey

@NotNull
PlanResultKey getPlanResultKey()

Gets the PlanResultKey for the current BuildIdentifier

Returns:

planResultKey

getProjectName

@NotNull
String getProjectName()