Package jetbrains.buildServer.serverSide

Interface SFinishedBuild

All Superinterfaces:

Build, BuildPromotionOwner, ParametersSupport, SBuild

All Known Subinterfaces:

FinishedBuildEx

All Known Implementing Classes:

FinishedBuildImpl, SecuredFinishedBuildImpl

public interface SFinishedBuild
extends SBuild

Finished build object.

Method Summary

Modifier and Type	Method	Description
Date	getFinishDate()	Returns finish timestamp for the build.
Date	getFinishOnAgentDate()	Returns timestamp when the build finished on agent (server time).
Comment	getPinComment()	Returns the pin/unpin comment
void	setLabel(String labelValue, String message, List<VcsRootInstance> rootsToLabel)	Sets a label on files in VCS repository used by this build in the specified VCS roots
void	setLabel(String labelValue, List<VcsRootInstance> rootsToLabel)	Sets a label on files in VCS repository used by this build in the specified VCS roots
void	setPinned(boolean pinned)	Deprecated. Use setPinned(boolean, jetbrains.buildServer.users.User, String) method
void	setPinned(boolean pinned, User user, String comment)	Sets pin status for this build.

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

getBuildPromotion, getSequenceBuild

Methods inherited from interface jetbrains.buildServer.serverSide.ParametersSupport

getParametersProvider

Methods inherited from interface jetbrains.buildServer.serverSide.SBuild

addBuildProblem, addUserBuildProblem, convertToAgentTime, convertToServerTime, getAgent, getArtifactDependencies, getArtifacts, getArtifactsDirectory, getBranch, getBuildComment, getBuildDescription, getBuildFeaturesOfType, getBuildLog, 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

Method Detail

setPinned

void setPinned(boolean pinned,
               @Nullable
               User user,
               @Nullable
               String comment)

Sets pin status for this build. Pinned builds will not be cleaned by the server cleanup process.

Parameters:

pinned - whether to pin build or not.

user - user who pins/unpins build

comment - comment

setPinned

@Deprecated
void setPinned(boolean pinned)

Deprecated.

Use setPinned(boolean, jetbrains.buildServer.users.User, String) method

Sets pin status for this build. Pinned builds will not be cleaned by the server cleanup process.

Parameters:

pinned - whether to pin build or not.

getPinComment

@Nullable
Comment getPinComment()

Returns the pin/unpin comment

Returns:

the pin/unpin comment or null if the build has never been pinned/unpinned

setLabel

void setLabel(String labelValue,
              List<VcsRootInstance> rootsToLabel)
       throws VcsException

Sets a label on files in VCS repository used by this build in the specified VCS roots

Parameters:

labelValue - label to set

rootsToLabel - VCS roots to label

Throws:

VcsException - if labeling failed

setLabel

void setLabel(String labelValue,
              @Nullable
              String message,
              List<VcsRootInstance> rootsToLabel)
       throws VcsException

Sets a label on files in VCS repository used by this build in the specified VCS roots

Parameters:

labelValue - label to set

comment - label comment

rootsToLabel - VCS roots to label

Throws:

VcsException

getFinishDate

@NotNull
Date getFinishDate()

Returns finish timestamp for the build.

Specified by:

getFinishDate in interface Build

Returns:

Date/time when the build has been finished.

getFinishOnAgentDate

@NotNull
Date getFinishOnAgentDate()

Returns timestamp when the build finished on agent (server time).

Specified by:

getFinishOnAgentDate in interface SBuild

Returns:

see above