Package com.atlassian.bamboo.v2.build

Interface CommonContext

All Superinterfaces:

Serializable

All Known Subinterfaces:

BuildContext, DeploymentContext

All Known Implementing Classes:

BuildContextImpl, DeploymentContextImpl, DeploymentRepositoryBuildContext

public interface CommonContext
extends Serializable

Parent interface for the object keeping the data required for the chain execution

Method Summary

Modifier and Type	Method	Description
@NotNull CommonArtifactContext	getArtifactContext()
@NotNull BuildKey	getBuildKey()
@NotNull Map<PlanKey,ChainStorageTag>	getChainStorageTags()
CurrentResult	getCurrentResult()
String	getDisplayName()	A human friendly description of what is being built.
@NotNull DockerPipelineConfiguration	getDockerPipelineConfiguration()
Long	getEntityGroupId()	Returns id of a group entity belongs to.
long	getEntityId()
Key	getEntityKey()
@NotNull ErrorCollection	getErrorCollection()	Any errors associated with the build
ResultKey	getResultKey()
@NotNull List<RuntimeTaskDefinition>	getRuntimeTaskDefinitions()	All tasks defined for this build.
@NotNull Iterable<CredentialsData>	getSharedCredentials()
@NotNull TriggerReason	getTriggerReason()	The reason this build was triggered
@NotNull VariableContext	getVariableContext()
@NotNull List<PlanRepositoryDefinition>	getVcsRepositories()
@NotNull Map<Long,PlanRepositoryDefinition>	getVcsRepositoryMap()
boolean	isExpectingCustomDedicatedAgent()	If this job is expected to be built on a custom dedicated agent
boolean	isVerboseLoggingOn()	Controls the amount of logging during the execution.

Method Detail

getBuildKey

@NotNull
@NotNull BuildKey getBuildKey()

getEntityId

long getEntityId()

getEntityGroupId

Long getEntityGroupId()

Returns id of a group entity belongs to. E.g. returns deployment project's id if entity is a deployment environment.

Returns:

id of entity group or null if not applicable.

getEntityKey

Key getEntityKey()

getResultKey

ResultKey getResultKey()

getDisplayName

String getDisplayName()

A human friendly description of what is being built.

Returns:

getCurrentResult

CurrentResult getCurrentResult()

getArtifactContext

@NotNull
@NotNull CommonArtifactContext getArtifactContext()

Returns:

Artifact data associated with plan or deployment

getErrorCollection

@NotNull
@NotNull ErrorCollection getErrorCollection()

Any errors associated with the build

getRuntimeTaskDefinitions

@NotNull
@NotNull List<RuntimeTaskDefinition> getRuntimeTaskDefinitions()

All tasks defined for this build. Contains both regular tasks and finalising tasks.

Returns:

A List of RuntimeTaskDefinitions

getVariableContext

@NotNull
@NotNull VariableContext getVariableContext()

getTriggerReason

@NotNull
@NotNull TriggerReason getTriggerReason()

The reason this build was triggered

Returns:

triggerReason

getVcsRepositoryMap

@NotNull
@NotNull Map<Long,PlanRepositoryDefinition> getVcsRepositoryMap()

getVcsRepositories

@NotNull
@NotNull List<PlanRepositoryDefinition> getVcsRepositories()

getSharedCredentials

@NotNull
@NotNull Iterable<CredentialsData> getSharedCredentials()

getChainStorageTags

@NotNull
@NotNull Map<PlanKey,ChainStorageTag> getChainStorageTags()

getDockerPipelineConfiguration

@NotNull
@NotNull DockerPipelineConfiguration getDockerPipelineConfiguration()

isVerboseLoggingOn

boolean isVerboseLoggingOn()

Controls the amount of logging during the execution. Some of the logging is only output in verbose mode.

Returns:

true if verbose logging is enabled.

Since:

7.2

isExpectingCustomDedicatedAgent

boolean isExpectingCustomDedicatedAgent()

If this job is expected to be built on a custom dedicated agent