ImmutableResultsSummary (Atlassian Bamboo 6.0.0 API)

All Superinterfaces:

BambooIdProvider, Comparable<ImmutableResultsSummary>, ResultStatisticsProvider

All Known Subinterfaces:

BuildResultsSummary, ChainResultsSummary, ImmutableChainResultsSummary, MutableBuildKeyResultsSummary, ResultsSummary

All Known Implementing Classes:

AbstractResultsSummary, BaseResultSummary, BuildResultsSummaryDocument, BuildResultsSummaryImpl, ChainResultsSummaryDocument, ChainResultsSummaryImpl, ImmutableResultsSummaryImpl
```
public interface ImmutableResultsSummary
extends BambooIdProvider, ResultStatisticsProvider, Comparable<ImmutableResultsSummary>
```

Field Summary

Fields
Modifier and Type Field and Description

static String CUSTOM_DATA_BUILD_KEY

Fields
Modifier and Type	Field and Description
`static String`	`CUSTOM_DATA_BUILD_KEY`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`Collection<ArtifactLink>`	`getArtifactLinks()` Returns all artifacts associated with this build.
`Collection<ArtifactLink>`	`getArtifactLinksThatExist()` Deprecated. since 4.3
`Long`	`getBuildAgentId()` The id of the latest agent that built the result
`Date`	`getBuildCancelledDate()` When the build was cancelled
`Date`	`getBuildCompletedDate()` When the build finished
`String`	`getBuildTime()` Formatted buildDate.
`String`	`getChangesListSummary()`
`com.google.common.collect.ImmutableList<Commit>`	`getCommits()` List of commits associated with the build represented by this summary
`Map<String,String>`	`getCustomBuildData()` Custom data map to store random metadata about the build
`DeltaState`	`getDeltaState()` Gets the `DeltaState` of the summary.
`long`	`getDuration()` Duration of the build in milliseconds
`String`	`getDurationDescription()` Returns the duration in a "pretty" format.
`Set<LinkedJiraIssue>`	`getFixingJiraIssues()` Return JIRA issues that this build result summary fixes
`ImmutablePlan`	`getImmutablePlan()` Gets the `ImmutablePlan` that this result belongs directly belongs to
`Set<String>`	`getJiraIssueKeys()` Returns all the JIRA issue keys linked to this build result
`Set<LinkedJiraIssue>`	`getJiraIssues()` Returns all the JIRA issues linked to this build result
`List<Labelling>`	`getLabellings()` Tags / labels associated with the build
`List<String>`	`getLabelNames()` A shortcut method to get all of the label names from the labellings
`LifeCycleState`	`getLifeCycleState()`
`Long`	`getLogSize()` Returns the size of log associated with this result.
`List<VariableSubstitution>`	`getManuallyOverriddenVariables()` Deprecated. since 5.15 for internal use only, use `ResultsSummaryVariableAccessor` instead
`ImmutablePlan`	`getPlan()` Deprecated. since 5.0 use `getImmutablePlan()`
`PlanKey`	`getPlanKey()` Full key of the plan.
`PlanResultKey`	`getPlanResultKey()` Gets the `PlanResultKey` for this `ImmutableResultsSummary`
`long`	`getProcessingDuration()` Duration of actual build processing in miliseconds
`String`	`getProcessingDurationDescription()` Returns the processing duration in a "pretty" format.
`Date`	`getQueueTime()` When the build queued
`String`	`getReasonSummary()`
`Set<LinkedJiraIssue>`	`getRelatedJiraIssues()` Returns JIRA issues that are related to this build result.
`String`	`getRelativeBuildDate()`
`String`	`getRelativeBuildDate(Date comparedTo)`
`String`	`getRelativeBuildStartedDate()` Returns the relative started time (duration) compared to current date
`String`	`getRelativeBuildStartedDate(Date comparedTo)` Returns the relative started time (duration) compared to date passed as parameter
`String`	`getRelativeQueueDate()`
`String`	`getRelativeQueueDate(Date comparedTo)`
`List<RepositoryChangeset>`	`getRepositoryChangesets()`
`int`	`getRestartCount()` Return the number of build restart attempts
`String`	`getShortReasonSummary()`
`List<ConsumedSubscription>`	`getSubscriptions()` Returns list of consumed artifact dependencies `ConsumedSubscription`
`List<VariableSubstitution>`	`getSubstitutedVariables()` Deprecated. since 5.15 without replacement, returns empty list for any result created by Bamboo 5.15 or later
`TestResultsSummary`	`getTestResultsSummary()`
`String`	`getTestSummary()`
`Long`	`getTimeToFix()` A stored version of how long (milli seconds) it took for this build to fix a failure.
`TriggerReason`	`getTriggerReason()` Why the build was was triggered
`Set<Author>`	`getUniqueAuthors()` A shortcut method to get the unique set of authors contributing to this build.
`com.google.common.collect.ImmutableList<VariableBaselineItem>`	`getVariableContext()` Deprecated. since 5.7 for internal use only, use `ResultsSummaryVariableAccessor` instead
`List<VariableContextSnapshot>`	`getVariableContextLogs()` Deprecated. since 5.7 for internal use only, use `ResultsSummaryVariableAccessor` instead
`boolean`	`hasChanges()` Whether a build had changes or not
`boolean`	`hasComments()` Deprecated. since 5.15 use `CommentManager` (or ctx.hasComments in Freemarker(
`boolean`	`isActive()` Shortcut method to see if `getLifeCycleState()` is `LifeCycleState.PENDING` or `LifeCycleState.QUEUED` or `LifeCycleState.IN_PROGRESS`
`boolean`	`isCustomBuild()` Indicates that this result was run with custom variables (some of the variables were overwritten) - used to display indicator in UI
`boolean`	`isFailed()` Shortcut method to see if `ResultStatisticsProvider.getBuildState()` is `BuildState.FAILED`
`boolean`	`isFinished()` Shortcut method to see if `getLifeCycleState()` is `LifeCycleState.FINISHED`
`boolean`	`isInProgress()` Shortcut method to see if `getLifeCycleState()` is `LifeCycleState.IN_PROGRESS`
`boolean`	`isNotBuilt()` Shortcut method to see if `getLifeCycleState()` is `LifeCycleState.NOT_BUILT`
`boolean`	`isNotRunYet()` Tells whether this result belongs to a job that will run when next manual stage is kicked off
`boolean`	`isOnceOff()` Indicates that this result was run with custom revision and should be considered as 'once-off' when calculating telemetry and other stuff
`boolean`	`isPending()` Shortcut method to see if `getLifeCycleState()` is `LifeCycleState.PENDING`
`boolean`	`isQueued()` Shortcut method to see if `getLifeCycleState()` is `LifeCycleState.QUEUED`
`boolean`	`isRebuild()` Indicates that this result was rebuild via "re-run this build" action.
`boolean`	`isSuccessful()` Shortcut method to see if `ResultStatisticsProvider.getBuildState()` is `BuildState.SUCCESS`
`boolean`	`isWaiting()` Shortcut method to see if `getLifeCycleState()` is `LifeCycleState.PENDING` or `LifeCycleState.QUEUED`

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

Methods inherited from interface com.atlassian.bamboo.resultsummary.ResultStatisticsProvider
getBuildDate, getBuildNumber, getBuildState, getStatDate

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - CUSTOM_DATA_BUILD_KEY
```
static final String CUSTOM_DATA_BUILD_KEY
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getPlanResultKey
```
@NotNull
PlanResultKey getPlanResultKey()
```
    Gets the PlanResultKey for this ImmutableResultsSummary
    
    Returns:
    
    planResultKey
  - getImmutablePlan
```
@NotNull
ImmutablePlan getImmutablePlan()
```
    Gets the ImmutablePlan that this result belongs directly belongs to
    
    Returns:
    
    the owning plan for the result
    
    Throws:
    
    IllegalStateException - if the plan doesn't exist.
  - getPlan
```
@NotNull
 @Deprecated
ImmutablePlan getPlan()
```
    Deprecated. since 5.0 use getImmutablePlan()
    
    Gets the Plan that this result belongs directly belongs to
    
    Returns:
    
    the owning plan for the result
    
    Throws:
    
    IllegalStateException - if the plan doesn't exist.
  - getPlanKey
```
@NotNull
PlanKey getPlanKey()
```
    Full key of the plan. e.g BAM-MAIN
    
    Returns:
  - getTriggerReason
```
@NotNull
TriggerReason getTriggerReason()
```
    Why the build was was triggered
    
    Returns:
  - getDeltaState
```
DeltaState getDeltaState()
```
    Gets the DeltaState of the summary. It can be a build that fixes, breaks, failing, successful. Provides a status relative to the previous summary.
    
    Returns:
  - isOnceOff
```
boolean isOnceOff()
```
    Indicates that this result was run with custom revision and should be considered as 'once-off' when calculating telemetry and other stuff
    
    Returns:
  - isCustomBuild
```
boolean isCustomBuild()
```
    Indicates that this result was run with custom variables (some of the variables were overwritten) - used to display indicator in UI
    
    Returns:
  - isRebuild
```
boolean isRebuild()
```
    Indicates that this result was rebuild via "re-run this build" action.
    
    Returns:
  - getLogSize
```
@Nullable
Long getLogSize()
```
    Returns the size of log associated with this result.
    For a BuildResultsSummary this method will return size of the log produced by the Job.
    For a ChainResultsSummary the returned value will be equal to the maximum log size produced by this Chain's Jobs.
    
    Returns:
    
    the log size or null, if the value is not known
  - getDuration
```
long getDuration()
```
    Duration of the build in milliseconds
    
    Specified by:
    
    getDuration in interface ResultStatisticsProvider
    
    Returns:
  - getProcessingDuration
```
long getProcessingDuration()
```
    Duration of actual build processing in miliseconds
    
    Specified by:
    
    getProcessingDuration in interface ResultStatisticsProvider
    
    Returns:
  - getBuildCancelledDate
```
@Nullable
Date getBuildCancelledDate()
```
    When the build was cancelled
    
    Returns:
    
    date of build cancellation or null if build was not cancelled
  - getBuildCompletedDate
```
@Nullable
Date getBuildCompletedDate()
```
    When the build finished
    
    Returns:
  - isFailed
```
boolean isFailed()
```
    Shortcut method to see if ResultStatisticsProvider.getBuildState() is BuildState.FAILED
    
    Returns:
  - isSuccessful
```
boolean isSuccessful()
```
    Shortcut method to see if ResultStatisticsProvider.getBuildState() is BuildState.SUCCESS
    
    Returns:
  - isPending
```
boolean isPending()
```
    Shortcut method to see if getLifeCycleState() is LifeCycleState.PENDING
    
    Returns:
  - isQueued
```
boolean isQueued()
```
    Shortcut method to see if getLifeCycleState() is LifeCycleState.QUEUED
    
    Returns:
  - isInProgress
```
boolean isInProgress()
```
    Shortcut method to see if getLifeCycleState() is LifeCycleState.IN_PROGRESS
    
    Returns:
  - isNotBuilt
```
boolean isNotBuilt()
```
    Shortcut method to see if getLifeCycleState() is LifeCycleState.NOT_BUILT
    
    Returns:
  - isFinished
```
boolean isFinished()
```
    Shortcut method to see if getLifeCycleState() is LifeCycleState.FINISHED
    
    Returns:
  - isWaiting
```
boolean isWaiting()
```
    Shortcut method to see if getLifeCycleState() is LifeCycleState.PENDING or LifeCycleState.QUEUED
    
    Returns:
  - isActive
```
boolean isActive()
```
    Shortcut method to see if getLifeCycleState() is LifeCycleState.PENDING or LifeCycleState.QUEUED or LifeCycleState.IN_PROGRESS
    
    Returns:
  - getCustomBuildData
```
@NotNull
Map<String,String> getCustomBuildData()
```
    Custom data map to store random metadata about the build
    
    Returns:
  - getJiraIssues
```
@NotNull
Set<LinkedJiraIssue> getJiraIssues()
```
    Returns all the JIRA issues linked to this build result
    
    Returns:
  - getFixingJiraIssues
```
@NotNull
Set<LinkedJiraIssue> getFixingJiraIssues()
```
    Return JIRA issues that this build result summary fixes
    
    Returns:
  - getRelatedJiraIssues
```
@NotNull
Set<LinkedJiraIssue> getRelatedJiraIssues()
```
    Returns JIRA issues that are related to this build result. Does not include fixing issues
    
    Returns:
  - getJiraIssueKeys
```
Set<String> getJiraIssueKeys()
```
    Returns all the JIRA issue keys linked to this build result
    
    Returns:
  - getRepositoryChangesets
```
@NotNull
List<RepositoryChangeset> getRepositoryChangesets()
```
  - hasComments
```
@Deprecated
boolean hasComments()
```
    Deprecated. since 5.15 use CommentManager (or ctx.hasComments in Freemarker(
    
    Checks if the result has any user comments for the build
    
    Returns:
  - getLabellings
```
List<Labelling> getLabellings()
```
    Tags / labels associated with the build
    
    Returns:
  - getLabelNames
```
@NotNull
List<String> getLabelNames()
```
    A shortcut method to get all of the label names from the labellings
    
    Returns:
  - getUniqueAuthors
```
Set<Author> getUniqueAuthors()
```
    A shortcut method to get the unique set of authors contributing to this build.
    
    Returns:
    
    Set of Authors
  - hasChanges
```
boolean hasChanges()
```
    Whether a build had changes or not
    
    Returns:
  - getTimeToFix
```
@Nullable
Long getTimeToFix()
```
    A stored version of how long (milli seconds) it took for this build to fix a failure.
    
    Returns:
    
    Null if not a fixing build
  - getTestResultsSummary
```
@NotNull
TestResultsSummary getTestResultsSummary()
```
    Returns:
    
    a summary of all the tests that ran in this build.
  - getDurationDescription
```
@NotNull
String getDurationDescription()
```
    Returns the duration in a "pretty" format. Handles when duration is not known
    
    Returns:
    
    formatted duration
  - getProcessingDurationDescription
```
String getProcessingDurationDescription()
```
    Returns the processing duration in a "pretty" format. Handles unknown processing duration.
    
    Returns:
    
    formatted processing duration
  - getShortReasonSummary
```
String getShortReasonSummary()
```
  - getReasonSummary
```
String getReasonSummary()
```
  - getRelativeBuildDate
```
String getRelativeBuildDate()
```
  - getRelativeQueueDate
```
String getRelativeQueueDate()
```
  - getRelativeBuildStartedDate
```
String getRelativeBuildStartedDate()
```
    Returns the relative started time (duration) compared to current date
    
    Returns:
    
    relative duration
  - getTestSummary
```
@NotNull
String getTestSummary()
```
  - getRelativeBuildDate
```
String getRelativeBuildDate(Date comparedTo)
```
  - getRelativeQueueDate
```
String getRelativeQueueDate(Date comparedTo)
```
  - getRelativeBuildStartedDate
```
String getRelativeBuildStartedDate(Date comparedTo)
```
    Returns the relative started time (duration) compared to date passed as parameter
    
    Parameters:
    
    comparedTo -
    
    Returns:
    
    relative duration
  - getBuildTime
```
String getBuildTime()
```
    Formatted buildDate. When the build was started
    
    Returns:
  - getQueueTime
```
@Nullable
Date getQueueTime()
```
    When the build queued
    
    Returns:
  - getArtifactLinks
```
@NotNull
Collection<ArtifactLink> getArtifactLinks()
```
    Returns all artifacts associated with this build. Even if the files don't exist
    
    Returns:
  - getArtifactLinksThatExist
```
@Deprecated
Collection<ArtifactLink> getArtifactLinksThatExist()
```
    Deprecated. since 4.3
    
    Returns only artifacts that exists
    
    Returns:
  - getLifeCycleState
```
LifeCycleState getLifeCycleState()
```
  - getChangesListSummary
```
@NotNull
String getChangesListSummary()
```
  - getSubscriptions
```
@NotNull
List<ConsumedSubscription> getSubscriptions()
```
    Returns list of consumed artifact dependencies ConsumedSubscription
    
    Returns:
  - getSubstitutedVariables
```
@NotNull
 @Deprecated
List<VariableSubstitution> getSubstitutedVariables()
```
    Deprecated. since 5.15 without replacement, returns empty list for any result created by Bamboo 5.15 or later
    
    Returns list of variables substituted during build execution
    
    Returns:
  - getVariableContextLogs
```
@Deprecated
 @NotNull
List<VariableContextSnapshot> getVariableContextLogs()
```
    Deprecated. since 5.7 for internal use only, use ResultsSummaryVariableAccessor instead
  - getVariableContext
```
@Deprecated
 @NotNull
com.google.common.collect.ImmutableList<VariableBaselineItem> getVariableContext()
```
    Deprecated. since 5.7 for internal use only, use ResultsSummaryVariableAccessor instead
  - getManuallyOverriddenVariables
```
@Deprecated
List<VariableSubstitution> getManuallyOverriddenVariables()
```
    Deprecated. since 5.15 for internal use only, use ResultsSummaryVariableAccessor instead
    
    Returns empty list for any result created by Bamboo 5.15 or later
  - getRestartCount
```
int getRestartCount()
```
    Return the number of build restart attempts
    
    Returns:
  - isNotRunYet
```
boolean isNotRunYet()
```
    Tells whether this result belongs to a job that will run when next manual stage is kicked off
    
    Returns:
  - getCommits
```
com.google.common.collect.ImmutableList<Commit> getCommits()
```
    List of commits associated with the build represented by this summary
    
    Returns:
    
    list of commits
  - getBuildAgentId
```
@Nullable
Long getBuildAgentId()
```
    The id of the latest agent that built the result
    
    Returns:
    
    Null if no agents involved or unknown

Interface ImmutableResultsSummary

Field Summary

Method Summary

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

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

Methods inherited from interface java.lang.Comparable

Field Detail

CUSTOM_DATA_BUILD_KEY

Method Detail

getPlanResultKey

getImmutablePlan

getPlan

getPlanKey

getTriggerReason

getDeltaState

isOnceOff

isCustomBuild

isRebuild

getLogSize

getDuration

getProcessingDuration

getBuildCancelledDate

getBuildCompletedDate

isFailed

isSuccessful

isPending

isQueued

isInProgress

isNotBuilt

isFinished

isWaiting

isActive

getCustomBuildData

getJiraIssues

getFixingJiraIssues

getRelatedJiraIssues

getJiraIssueKeys

getRepositoryChangesets

hasComments

getLabellings

getLabelNames

getUniqueAuthors

hasChanges

getTimeToFix

getTestResultsSummary

getDurationDescription

getProcessingDurationDescription

getShortReasonSummary

getReasonSummary

getRelativeBuildDate

getRelativeQueueDate

getRelativeBuildStartedDate

getTestSummary

getRelativeBuildDate

getRelativeQueueDate

getRelativeBuildStartedDate

getBuildTime

getQueueTime

getArtifactLinks

getArtifactLinksThatExist

getLifeCycleState

getChangesListSummary

getSubscriptions

getSubstitutedVariables

getVariableContextLogs

getVariableContext

getManuallyOverriddenVariables

getRestartCount

isNotRunYet

getCommits

getBuildAgentId