Package jetbrains.buildServer

Class AddToQueueRequest

  • public class AddToQueueRequest
extends 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 Detail

      • AddToQueueRequest

        public AddToQueueRequest​(String buildTypeId,
                         long changeListId)
        Constructor for personal builds
        Parameters:
        buildTypeId - id of build configuration
        changeListId - id of personal changelist

      • AddToQueueRequest

        public AddToQueueRequest​(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 Long getChangeListId()
        Returns personal change list id associated with this build or null if build is not personal
        Returns:
        see above

      • getBuildTypeId

        public String getBuildTypeId()
        Returns build configuration id
        Returns:
        build configuration id

      • getAgentId

        public Integer getAgentId()
        Returns agent id (can be null)
        Returns:
        agent id

      • getAgentPoolId

        public Integer getAgentPoolId()
        Returns agent pool id (can be null)
        Returns:
        agent pool id

      • getBuildParameters

        public Map<String,​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:
        true if checking for changes must be performed as early as possible

      • isCleanSources

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

      • getDebugSessionInfos

        public Map<String,​DebugSessionInfo> getDebugSessionInfos()
        Returns specified debug session infos or null.
        Returns:
        map: build runner id -> debug session info

      • setChangeListId

        public void setChangeListId​(Long changeListId)
        Sets the change-list id (for personal builds)
        Parameters:
        changeListId - change list id

      • setAgentId

        public void setAgentId​(Integer agentId)
        Sets the agent id
        Parameters:
        agentId - agent id

      • setAgentPoolId

        public void setAgentPoolId​(Integer agentPoolId)
        Sets the agent pool id
        Parameters:
        agentPoolId - agent pool id

      • setBuildParameters

        public void setBuildParameters​(Map<String,​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 - - set to true in case when check for changes should be performed as early as possible

      • setCleanSources

        public void setCleanSources​(boolean cleanSources)
        Sets the 'cleanSources' option
        Parameters:
        cleanSources - the option value

      • addDebugSessionInfo

        public void addDebugSessionInfo​(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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object