Package com.atlassian.bamboo.chains

Interface ChainResultsSummary

All Superinterfaces:

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

All Known Implementing Classes:

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	Description
boolean	addStageResult(@NotNull ChainStageResult chainStageResult)	Add a stage result
@NotNull ChainStageResult	createStageResult(@NotNull ImmutableChainStage chainStage)	Create a new ChainStageResult and associates it with the ChainResultsSummary
boolean	removeStageResult(@NotNull ChainStageResult chainStageResult)	Remove a stage result
void	setContinuable(boolean continuable)
void	setFixedInResult(@Nullable Integer resultNumber)	Set the result that this result was fixed in.
void	setMergeResult(@Nullable MergeResultSummary mergeResult)	Note: this API is experimental.
void	setSpecsResult(boolean specsResult)

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

updateCustomDataEntry

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

getId

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

setId

Methods inherited from interface java.lang.Comparable

compareTo

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

setMarkedForDeletion

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

getFailedJobResults, getFixedInResult, getImmutablePlan, getMergeResult, getOrderedJobResultSummaries, getPlanIfExists, getStageResults, getTestResults, getTotalJobCount, isContinuable, isRestartable, isSpecsResult

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

isMarkedForDeletion

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

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

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

getPlanResultKey

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

addVariableContextItem, getBuildKey, getBuildResultKey, getFormatVersion, getImmutablePlan, getSubstitutedVariablesEncrypted, getVariableContextBaselineId, getVariableContextLogsEncrypted, incrementRestartCount, resetTestClassResults, setBuildAgentId, setBuildAgentType, setBuildCancelledDate, setBuildCompletedDate, setBuildDate, setCustomBuild, setDeltaState, setDuration, setLogSize, setOnceOff, setProcessingDuration, setQueueTime, setRebuild, setRestartCount, setTestResultsSummary, setTimeToFix, setTriggerReason, updateFormatVersion, updateLifeCycleState

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

getBuildDate, getBuildNumber, getBuildState, getStatDate

Method Detail

createStageResult

@NotNull
@NotNull ChainStageResult createStageResult(@NotNull
                                            @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
                       @NotNull ChainStageResult chainStageResult)

Add a stage result

Parameters:

chainStageResult -

Returns:

success

removeStageResult

boolean removeStageResult(@NotNull
                          @NotNull ChainStageResult chainStageResult)

Remove a stage result

Parameters:

chainStageResult -

Returns:

success

setContinuable

void setContinuable(boolean continuable)

setMergeResult

void setMergeResult(@Nullable
                    @Nullable MergeResultSummary mergeResult)

Note: this API is experimental.

Parameters:

mergeResult -

Since:

4.0

setFixedInResult

void setFixedInResult(@Nullable
                      @Nullable Integer resultNumber)

Set the result that this result was fixed in.

Parameters:

resultNumber -

setSpecsResult

void setSpecsResult(boolean specsResult)

Since:

7.1