Package jetbrains.buildServer.serverSide.impl

Interface FinishedBuildEx

All Superinterfaces:

Build, BuildPromotionOwner, ParametersSupport, SBuild, SFinishedBuild

All Known Implementing Classes:

FinishedBuildImpl, SecuredFinishedBuildImpl

public interface FinishedBuildEx
extends SFinishedBuild

Method Summary

Modifier and Type	Method	Description
void	beforeDelete(boolean sendEvent)	This method should be called before build is going to be deleted.
void	buildEvictedFromCache()	This method is called when the build is about to be removed from the cache
BuildAgentEx	getAgent()
Map<String,String>	getBuildFinishParameters()	This method returns build parameters (env, config, system) that were on build agent at the end of this build.
BuildLogEx	getBuildLog()	Returns build log.
BuildLogEx	getBuildLogIfInitialized()
BuildPromotionEx	getBuildPromotion()	Returns build promotion
Map<String,String>	getBuildStartParameters()	This method returns build parameters (env, config, system) that were on build agent before build runners are called in the build.
SortedMap<BuildTypeEx,BuildPromotionEx>	getDeploymentStatus()
void	resetFullStatisticsCache()
void	resetShortStatisticsCache()
void	setStatusText(String newText)	Deprecated. since 2020.2
void	updatePinInfo()	Reload pin status from the database
void	updateStatusText()	Recalculate status line text

Methods inherited from interface jetbrains.buildServer.Build

getAgentName, getBuildId, getBuildNumber, getBuildStatus, getBuildTypeExternalId, getBuildTypeId, getBuildTypeName, getCanceledInfo, getCompilationErrorMessages, getDuration, getFullName, getLogMessages, getProjectExternalId, getProjectId, getStartDate, getStatusDescriptor, getTestMessages, isFinished, isPersonal

Methods inherited from interface jetbrains.buildServer.serverSide.BuildPromotionOwner

getSequenceBuild

Methods inherited from interface jetbrains.buildServer.serverSide.ParametersSupport

getParametersProvider

Methods inherited from interface jetbrains.buildServer.serverSide.SBuild

addBuildProblem, addUserBuildProblem, convertToAgentTime, convertToServerTime, getArtifactDependencies, getArtifacts, getArtifactsDirectory, getBranch, getBuildComment, getBuildDescription, getBuildFeaturesOfType, getBuildOwnParameters, getBuildStatistics, getBuildType, getChanges, getClientStartDate, getClientTimeZone, getCommitters, getContainingChanges, getCustomDataStorage, getDownloadedArtifacts, getFailureReasons, getFileContent, getFirstInternalError, getFirstInternalErrorMessage, getFullStatistics, getLabels, getOwner, getPreviousFinished, getProvidedArtifacts, getQueuedDate, getRawBuildNumber, getRecentlyFinishedBuild, getRelatedIssues, getRemoteArtifacts, getRemoteArtifactsByType, getRevisions, getServerStartDate, getShortStatistics, getStatisticValue, getStatisticValues, getTags, getTriggeredBy, getValueResolver, getVcsRootEntries, getWaitReasons, hasBuildProblemOfType, hasTests, isAgentLessBuild, isArtifactsExists, isCompositeBuild, isDetachedFromAgent, isHasInternalArtifactsOnly, isHasRelatedIssues, isInternalError, isOutdated, isOutOfChangesSequence, isPinned, isResponsibleNeeded, isStartedOnAgent, isUsedByOtherBuilds, muteBuildProblems, setBuildComment, setTags, setTags

Methods inherited from interface jetbrains.buildServer.serverSide.SFinishedBuild

getFinishDate, getFinishOnAgentDate, getPinComment, setLabel, setLabel, setPinned, setPinned

Method Detail

getAgent

@NotNull
BuildAgentEx getAgent()

Specified by:

getAgent in interface SBuild

Returns:

agent where this build executed.

resetFullStatisticsCache

void resetFullStatisticsCache()

resetShortStatisticsCache

void resetShortStatisticsCache()

setStatusText

@Deprecated
void setStatusText(@NotNull
                   String newText)

Deprecated.

since 2020.2

updateStatusText

void updateStatusText()

Recalculate status line text

Since:

2020.2

getBuildFinishParameters

@Nullable
Map<String,String> getBuildFinishParameters()

This method returns build parameters (env, config, system) that were on build agent at the end of this build.

This method may return null if there is no parameters were persisted

Returns:

map of all parameters

Since:

6.5

getBuildStartParameters

@Nullable
Map<String,String> getBuildStartParameters()

This method returns build parameters (env, config, system) that were on build agent before build runners are called in the build.

Parameters could change during the build by pluing or build/user actions

This method may return null if there is no parameters were persisted

Returns:

map of all parameters

Since:

6.5

getBuildPromotion

@NotNull
BuildPromotionEx getBuildPromotion()

Description copied from interface: BuildPromotionOwner

Returns build promotion

Specified by:

getBuildPromotion in interface BuildPromotionOwner

Returns:

see above.

getDeploymentStatus

@NotNull
SortedMap<BuildTypeEx,BuildPromotionEx> getDeploymentStatus()

Returns:

map of environment build configurations depending directly on configuration of this build by snapshot or artifact dependencies to the latest triggered build promotion which is using this build. If there is no triggered build yet, then corresponding value in map entry is null.

Since:

2017.2

updatePinInfo

void updatePinInfo()

Reload pin status from the database

Since:

2018.1

beforeDelete

void beforeDelete(boolean sendEvent)

This method should be called before build is going to be deleted. This method will send corresponding event, and will remember state (build promotion) inside the build to make sure this instance of the build can still be used even after data is deleted from database.

buildEvictedFromCache

void buildEvictedFromCache()

This method is called when the build is about to be removed from the cache

getBuildLog

@NotNull
BuildLogEx getBuildLog()

Description copied from interface: SBuild

Returns build log.

Specified by:

getBuildLog in interface SBuild

Returns:

build log.

getBuildLogIfInitialized

@Nullable
BuildLogEx getBuildLogIfInitialized()