Package com.atlassian.bamboo.chains

Interface ImmutableChainResultsSummary

All Superinterfaces:

BambooIdProvider, Comparable<ImmutableResultsSummary>, ImmutableResultsSummary, ResultStatisticsProvider

All Known Subinterfaces:

ChainResultsSummary

All Known Implementing Classes:

ChainResultsSummaryImpl, ImmutableResultsSummaryImpl

public interface ImmutableChainResultsSummary
extends ImmutableResultsSummary

Field Summary

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

CUSTOM_DATA_BUILD_KEY

Method Summary

Modifier and Type	Method	Description
@NotNull List<BuildResultsSummary>	getFailedJobResults()	Get a list of all failed job Results in this chain result
@Nullable Integer	getFixedInResult()	Get build result that this build was fixed in.
@NotNull ImmutableChain	getImmutablePlan()	Gets the ImmutablePlan that this result directly belongs to.
@Nullable MergeResultSummary	getMergeResult()	Note: this API is experimental.
@NotNull List<ResultsSummary>	getOrderedJobResultSummaries()	Returns all jobs ResultsSummary related to chain result summary Summaries are ordered by stages
@NotNull Optional<ImmutableChain>	getPlanIfExists()	Gets the ImmutablePlan that this result directly belongs to.
@NotNull List<ChainStageResult>	getStageResults()	Get all the ChainStageResult's associated with this ChainResultsSummary
@Nullable FilteredTestResults<TestClassResultDescriptor>	getTestResults()	Deprecated. since 5.12 construct your own instance of ChainFilteredTestResults
int	getTotalJobCount()
boolean	isContinuable()	Indicates that Chain execution has been stopped on manual stage and is waiting for user action
boolean	isRestartable()	Indicates that Chain execution has been failed and could be restarted from failure place
boolean	isSpecsResult()

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

getId

Methods inherited from interface java.lang.Comparable

compareTo

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.resultsummary.ResultStatisticsProvider

getBuildDate, getBuildNumber, getBuildState, getStatDate

Method Details

getStageResults

@NotNull
@NotNull List<ChainStageResult> getStageResults()

Get all the ChainStageResult's associated with this ChainResultsSummary

Returns:

results

getTestResults

@Nullable
@Deprecated
@Nullable FilteredTestResults<TestClassResultDescriptor> getTestResults()

Deprecated.

since 5.12 construct your own instance of ChainFilteredTestResults

Get the helper class to provide filtered test lists for this chain result

Returns:

helper class to provide filtered test lists for this chain result, null if the chain is still being built

getFailedJobResults

@NotNull
@NotNull List<BuildResultsSummary> getFailedJobResults()

Get a list of all failed job Results in this chain result

Returns:

a list of all failed job Results in this chain result

getTotalJobCount

int getTotalJobCount()

Returns:

how many job results exist

getOrderedJobResultSummaries

@NotNull
@NotNull List<ResultsSummary> getOrderedJobResultSummaries()

Returns all jobs ResultsSummary related to chain result summary Summaries are ordered by stages

Returns:

isContinuable

boolean isContinuable()

Indicates that Chain execution has been stopped on manual stage and is waiting for user action

Returns:

isRestartable

boolean isRestartable()

Indicates that Chain execution has been failed and could be restarted from failure place

Returns:

getMergeResult

@Nullable
@Nullable MergeResultSummary getMergeResult()

Note: this API is experimental.

Since:

4.0

getFixedInResult

@Nullable
@Nullable Integer getFixedInResult()

Get build result that this build was fixed in. If the build is succussful it will be null. If there is no successful build after this it will also be null. If the fixed in build is deleted. This will still reference the deleted result.

Returns:

getImmutablePlan

@NotNull
@NotNull ImmutableChain getImmutablePlan()

Description copied from interface: ImmutableResultsSummary

Gets the ImmutablePlan that this result directly belongs to. Since version 6.9 it is possible that ImmutableJob no longer exists but its results do, therefore it is recommended to use ImmutableResultsSummary.getPlanIfExists() instead of this method when operating on job results.

Specified by:

getImmutablePlan in interface ImmutableResultsSummary

Returns:

the owning plan for the result

getPlanIfExists

@NotNull
@NotNull Optional<ImmutableChain> getPlanIfExists()

Description copied from interface: ImmutableResultsSummary

Gets the ImmutablePlan that this result directly belongs to.

Specified by:

getPlanIfExists in interface ImmutableResultsSummary

Returns:

the owning plan for the result or empty if id doesn't exist.

isSpecsResult

boolean isSpecsResult()

Since:

7.1