com.atlassian.bamboo.chains

Interface ChainResultsSummary

All Superinterfaces:

BambooCustomDataAware, BambooIdProvider, BambooObject, Comparable<ImmutableResultsSummary>, Deletable, ImmutableChainResultsSummary, ImmutableDeletable, ImmutableResultsSummary, PlanResultKeyProvider, ResultsSummary, ResultStatisticsProvider

All Known Implementing Classes:

ChainResultsSummaryDocument, ChainResultsSummaryImpl

@PublicApi
public interface ChainResultsSummary
extends ImmutableChainResultsSummary, ResultsSummary

Represents an execution result of a Chain

Field Summary

Fields inherited from interface com.atlassian.bamboo.resultsummary.ImmutableResultsSummary

CUSTOM_DATA_BUILD_KEY

Fields inherited from interface com.atlassian.bamboo.plan.PlanResultKeyProvider

getPlanKey

Method Summary

Modifier and Type	Method and Description
boolean	addStageResult(ChainStageResult chainStageResult) Add a stage result
ChainStageResult	createStageResult(ImmutableChainStage chainStage) Create a new ChainStageResult and associates it with the ChainResultsSummary
ImmutableChain	getImmutablePlan() Gets the ImmutablePlan that this result belongs directly belongs to
Chain	getPlan() Deprecated. since 5.0
boolean	removeStageResult(ChainStageResult chainStageResult) Remove a stage result
void	setContinuable(boolean continuable)
void	setFixedInResult(Integer resultNumber) Set the result that this result was fixed in.
void	setMergeResult(MergeResultSummary mergeResult) Note: this API is experimental.

Methods inherited from interface com.atlassian.bamboo.chains.ImmutableChainResultsSummary

getFailedJobResults, getFixedInResult, getMergeResult, getOrderedJobResultSummaries, getStageResults, getTestResults, getTotalJobCount, isContinuable, isRestartable

Methods inherited from interface com.atlassian.bamboo.resultsummary.ResultsSummary

getBuildKey, getBuildResultKey, getFormatVersion, getVariableContextBaseline, incrementRestartCount, resetTestClassResults, setBuildAgentId, setBuildCancelledDate, setBuildCompletedDate, setBuildDate, setCustomBuild, setDeltaState, setDuration, setLogSize, setOnceOff, setProcessingDuration, setQueueTime, setRebuild, setTestResultsSummary, setTimeToFix, setTriggerReason, setVariableContextBaseline, updateFormatVersion, updateLifeCycleState

Methods inherited from interface com.atlassian.bamboo.deletion.Deletable

setMarkedForDeletion

Methods inherited from interface com.atlassian.bamboo.core.BambooObject

setId

Methods inherited from interface com.atlassian.bamboo.core.BambooIdProvider

getId

Methods inherited from interface com.atlassian.bamboo.plan.cache.ImmutableDeletable

isMarkedForDeletion

Methods inherited from interface com.atlassian.bamboo.resultsummary.ImmutableResultsSummary

getArtifactLinks, getArtifactLinksThatExist, getBuildAgentId, getBuildCancelledDate, getBuildCompletedDate, getBuildTime, getChangesListSummary, getComments, getCommits, getCustomBuildData, getDeltaState, getDuration, getDurationDescription, getFixingJiraIssues, getJiraIssueKeys, getJiraIssues, getLabellings, getLabelNames, getLifeCycleState, getLogSize, getManuallyOverriddenVariables, getPlanKey, getPlanResultKey, getProcessingDuration, getProcessingDurationDescription, getQueueTime, getReasonSummary, getRelatedJiraIssues, getRelativeBuildDate, getRelativeBuildDate, getRelativeBuildStartedDate, getRelativeBuildStartedDate, getRelativeQueueDate, getRelativeQueueDate, getRepositoryChangesets, getRestartCount, getShortReasonSummary, getSubscriptions, getSubstitutedVariables, getTestResultsSummary, getTestSummary, getTimeToFix, getTriggerReason, getUniqueAuthors, getVariableContext, getVariableContextLogs, hasChanges, hasComments, isActive, isCustomBuild, isFailed, isFinished, isInProgress, isNotBuilt, isNotRunYet, isOnceOff, isPending, isQueued, isRebuild, isSuccessful, isWaiting

Methods inherited from interface com.atlassian.bamboo.resultsummary.ResultStatisticsProvider

getBuildDate, getBuildNumber, getBuildState, getStatDate

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.atlassian.bamboo.core.BambooCustomDataAware

updateCustomDataEntry

Methods inherited from interface com.atlassian.bamboo.plan.PlanResultKeyProvider

getPlanResultKey

Method Detail

getImmutablePlan

@NotNull
ImmutableChain getImmutablePlan()

Description copied from interface: ImmutableResultsSummary

Gets the ImmutablePlan that this result belongs directly belongs to

Specified by:

getImmutablePlan in interface ImmutableResultsSummary

Specified by:

getImmutablePlan in interface ResultsSummary

Returns:

the owning plan for the result

getPlan

@NotNull
 @Deprecated
Chain getPlan()

Deprecated. since 5.0

Description copied from interface: ImmutableResultsSummary

Gets the Plan that this result belongs directly belongs to

Specified by:

getPlan in interface ImmutableResultsSummary

Specified by:

getPlan in interface ResultsSummary

Returns:

the owning plan for the result

createStageResult

@NotNull
ChainStageResult createStageResult(@NotNull
                                            ImmutableChainStage chainStage)

Create a new ChainStageResult and associates it with the ChainResultsSummary

Parameters:

chainStage - the Stage related to result

Returns:

chainStageResult

addStageResult

boolean addStageResult(@NotNull
                       ChainStageResult chainStageResult)

Add a stage result

Parameters:

chainStageResult -

Returns:

success

removeStageResult

boolean removeStageResult(@NotNull
                          ChainStageResult chainStageResult)

Remove a stage result

Parameters:

chainStageResult -

Returns:

success

setContinuable

void setContinuable(boolean continuable)

setMergeResult

void setMergeResult(@Nullable
                    MergeResultSummary mergeResult)

Note: this API is experimental.

Parameters:

mergeResult -

Since:

4.0

setFixedInResult

void setFixedInResult(@Nullable
                      Integer resultNumber)

Set the result that this result was fixed in.

Parameters:

resultNumber -