jetbrains.buildServer
Class AddToQueueRequest

java.lang.Object
  extended by jetbrains.buildServer.AddToQueueRequest

public class AddToQueueRequest
extends java.lang.Object

Contains information which is used to add build in the queue. This object is created by IDE plugin (or other XML RPC client) and is sent to the server when build is added in the queue.


Constructor Summary
AddToQueueRequest(java.lang.String buildTypeId)
          Constructor for non-personal builds
AddToQueueRequest(java.lang.String buildTypeId, long changeListId)
          Constructor for personal builds
 
Method Summary
 void addDebugSessionInfo(java.lang.String runnerId, DebugSessionInfo debugSessionInfo)
          Adds debug session info for the specified runner.
 boolean equals(java.lang.Object o)
           
 java.lang.Integer getAgentId()
          Returns agent id (can be null)
 java.lang.Integer getAgentPoolId()
          Returns agent pool id (can be null)
 java.util.Map<java.lang.String,java.lang.String> getBuildParameters()
          Returns custom build parameters
 java.lang.String getBuildTypeId()
          Returns build configuration id
 java.lang.Long getChangeListId()
          Returns personal change list id associated with this build or null if build is not personal
 java.util.Map<java.lang.String,DebugSessionInfo> getDebugSessionInfos()
          Returns specified debug session infos or null.
 int hashCode()
           
 boolean isCheckForChangesEarly()
          Returns true if checking for changes must be performed as early as possible to minimize changes included into the build.
 boolean isCleanSources()
          Returns true if all files in checkout directory should be cleaned before the build.
 boolean isPersonal()
          Returns whether this request if personal
 boolean isPutBuildOnTheQueueTop()
          Returns whether the build is requested to be put on top
 boolean isRebuildDependencies()
          Returns whether all dependencies are to be rebuilt
 void setAgentId(java.lang.Integer agentId)
          Sets the agent id
 void setAgentPoolId(java.lang.Integer agentPoolId)
          Sets the agent pool id
 void setBuildParameters(java.util.Map<java.lang.String,java.lang.String> buildParameters)
          Sets the build parameters map
 void setChangeListId(java.lang.Long changeListId)
          Sets the change-list id (for personal builds)
 void setCheckForChangesEarly(boolean checkForChangesEarly)
          If set to true, check for changes will be performed as early as possible.
 void setCleanSources(boolean cleanSources)
          Sets the 'cleanSources' option
 void setPutBuildOnTheQueueTop(boolean putBuildOnTheQueueTop)
          Sets the 'putBuildOnTop' option
 void setRebuildDependencies(boolean rebuildDependencies)
          Sets the 'rebuildDependencies' option
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AddToQueueRequest

public AddToQueueRequest(java.lang.String buildTypeId,
                         long changeListId)
Constructor for personal builds

Parameters:
buildTypeId - id of build configuration
changeListId - id of personal changelist

AddToQueueRequest

public AddToQueueRequest(java.lang.String buildTypeId)
Constructor for non-personal builds

Parameters:
buildTypeId - id of build configuration
Method Detail

isPersonal

public boolean isPersonal()
Returns whether this request if personal

Returns:
true if request is personal

getChangeListId

public java.lang.Long getChangeListId()
Returns personal change list id associated with this build or null if build is not personal

Returns:
see above

getBuildTypeId

public java.lang.String getBuildTypeId()
Returns build configuration id

Returns:
build configuration id

getAgentId

public java.lang.Integer getAgentId()
Returns agent id (can be null)

Returns:
agent id

getAgentPoolId

public java.lang.Integer getAgentPoolId()
Returns agent pool id (can be null)

Returns:
agent pool id

getBuildParameters

public java.util.Map<java.lang.String,java.lang.String> getBuildParameters()
Returns custom build parameters

Returns:
custom build parameters

isPutBuildOnTheQueueTop

public boolean isPutBuildOnTheQueueTop()
Returns whether the build is requested to be put on top

Returns:
true if build is requested to be put on top

isRebuildDependencies

public boolean isRebuildDependencies()
Returns whether all dependencies are to be rebuilt

Returns:
true if dependencies are to be rebuilt

isCheckForChangesEarly

public boolean isCheckForChangesEarly()
Returns true if checking for changes must be performed as early as possible to minimize changes included into the build.

Returns:

isCleanSources

public boolean isCleanSources()
Returns true if all files in checkout directory should be cleaned before the build.

Returns:

getDebugSessionInfos

public java.util.Map<java.lang.String,DebugSessionInfo> getDebugSessionInfos()
Returns specified debug session infos or null.

Returns:
map: build runner id -> debug session info

setChangeListId

public void setChangeListId(java.lang.Long changeListId)
Sets the change-list id (for personal builds)

Parameters:
changeListId - change list id

setAgentId

public void setAgentId(java.lang.Integer agentId)
Sets the agent id

Parameters:
agentId - agent id

setAgentPoolId

public void setAgentPoolId(java.lang.Integer agentPoolId)
Sets the agent pool id

Parameters:
agentPoolId - agent pool id

setBuildParameters

public void setBuildParameters(java.util.Map<java.lang.String,java.lang.String> buildParameters)
Sets the build parameters map

Parameters:
buildParameters - custom build parameters

setPutBuildOnTheQueueTop

public void setPutBuildOnTheQueueTop(boolean putBuildOnTheQueueTop)
Sets the 'putBuildOnTop' option

Parameters:
putBuildOnTheQueueTop - the option value

setRebuildDependencies

public void setRebuildDependencies(boolean rebuildDependencies)
Sets the 'rebuildDependencies' option

Parameters:
rebuildDependencies - the option value

setCheckForChangesEarly

public void setCheckForChangesEarly(boolean checkForChangesEarly)
If set to true, check for changes will be performed as early as possible. This will minimize number of changes included into the build.

Parameters:
checkForChangesEarly -

setCleanSources

public void setCleanSources(boolean cleanSources)
Sets the 'cleanSources' option

Parameters:
cleanSources - the option value

addDebugSessionInfo

public void addDebugSessionInfo(java.lang.String runnerId,
                                DebugSessionInfo debugSessionInfo)
Adds debug session info for the specified runner. Has no effect for non-personal "add to queue" request.

Parameters:
runnerId - runner id
debugSessionInfo - debug session info

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object