jetbrains.buildServer.serverSide
Interface SQueuedBuild

All Superinterfaces:

BuildPromotionOwner, QueuedBuild

public interface SQueuedBuild
extends QueuedBuild, BuildPromotionOwner

Build in the queue object.

Method Summary

SBuildAgent	getBuildAgent() If build configuration is scheduled to some specific build agent, this build agent is returned, otherwise null is returned
BuildEstimates	getBuildEstimates() Returns a BuildEstimates object describing the estimated values of the pending build.
SBuildType	getBuildType()
java.util.List<SBuildAgent>	getCanRunOnAgents() Returns agents this build can run on
java.lang.String	getRequestor() Deprecated. see getTriggeredBy()
TriggeredBy	getTriggeredBy() Returns details about who and how added this build in queue.
void	removeFromQueue(User user, java.lang.String comment) Removes this queued build from the build queue

Methods inherited from interface jetbrains.buildServer.QueuedBuild

getBuildAgentId, getBuildTypeId, getItemId, getOrderNumber, getWhenQueued, isPersonal

Methods inherited from interface jetbrains.buildServer.serverSide.BuildPromotionOwner

getBuildPromotion, getSequenceBuild

Method Detail

getBuildType

@NotNull
SBuildType getBuildType()

Returns:

build configuration object.

getCanRunOnAgents

java.util.List<SBuildAgent> getCanRunOnAgents()

Returns agents this build can run on

Returns:

agents this build can run on

getBuildAgent

SBuildAgent getBuildAgent()

If build configuration is scheduled to some specific build agent, this build agent is returned, otherwise null is returned

Returns:

build agent to run build on or null

getBuildEstimates

@Nullable
BuildEstimates getBuildEstimates()

Returns a BuildEstimates object describing the estimated values of the pending build. The returned time interval can be open, that is it doesn't contain the finish estimate (getEndPoint() returns null) in case of inability to estimate build duration. The time base for the time interval is the moment of invocation (with some accuracy).

Returns:

null if the times cannot be estimated or the build isn't in the queue.

removeFromQueue

void removeFromQueue(@Nullable
                     User user,
                     java.lang.String comment)

Removes this queued build from the build queue

Parameters:

user - user who initiated remove

comment - comment

getRequestor

@NotNull
java.lang.String getRequestor()

Deprecated. see getTriggeredBy()

Returns the reason, why configuration has been queued (for example, it might be trigger name, if configuration was triggered, of user name, it it was added to queue manually).

Returns:

string requestor.

getTriggeredBy

TriggeredBy getTriggeredBy()

Returns details about who and how added this build in queue.

Returns:

see above