Package 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	Description
int	getBuildNumber()	The build number being built
@NotNull String	getBuildResultKey()	Deprecated. since 6.0 use getPlanResultKey() instead
Optional<Long>	getMasterPlanId()
@Nullable BuildIdentifier	getParentBuildIdentifier()
Optional<Long>	getPlanDbId()
long	getPlanId()	Deprecated. since 6.9 use getPlanDbId()
@NotNull String	getPlanKey()	Deprecated. since 5.11, use getTypedPlanKey() instead
@NotNull String	getPlanName()	The full name of the Plan
@NotNull PlanResultKey	getPlanResultKey()	Gets the PlanResultKey for the current BuildIdentifier
@NotNull String	getProjectName()
@NotNull String	getShortName()	The short name of the Plan
@NotNull PlanKey	getTypedPlanKey()	Full plan key (e.g.
@NotNull UUID	getUuid()	Id of the run.

Method Detail

getParentBuildIdentifier

@Nullable
@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
@NotNull 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
@NotNull PlanKey getTypedPlanKey()

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

Returns:

Key for the plan BAM-MAIN

getPlanName

@NotNull
@NotNull String getPlanName()

The full name of the Plan

Returns:

DescriptionProvider.getName()

getShortName

@NotNull
@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
@NotNull 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
@NotNull PlanResultKey getPlanResultKey()

Gets the PlanResultKey for the current BuildIdentifier

Returns:

planResultKey

getProjectName

@NotNull
@NotNull String getProjectName()

getUuid

@NotNull
@NotNull UUID getUuid()

Id of the run. Allows to tell apart instances of build if a job is restarted.

Since:

9.0 get unique id of the specific run