Interface TriggerTask

  • All Known Implementing Classes:
    BatchTriggerTaskImpl

    public interface TriggerTask
    Trigger task describes how to add build in the queue.
    • Method Detail

      • getBuildPromotion

        @NotNull
        BuildPromotion getBuildPromotion()
        Returns build which will be added to the queue.
        Returns:
      • setRunOnAgentFromPool

        void setRunOnAgentFromPool​(@NotNull
                                   AgentPool pool)
        Sets pool where the build should be started. The build will be started on the idle agent from this pool.
        Parameters:
        pool - agent pool where to start build
      • getAgentPoolToRunOn

        @Nullable
        AgentPool getAgentPoolToRunOn()
        Returns:
        pool where to start build or null if pool is not set.
      • setRunOnAgent

        void setRunOnAgent​(@NotNull
                           SBuildAgent agent)
        Assigns build to the specified agent. If both pool and agent are set, agent will have higher precedence.
        Parameters:
        agent - agent where to start build
      • getAgentToRunOn

        @Nullable
        SBuildAgent getAgentToRunOn()
        Returns:
        agent where to start build or null.
      • setRunOnAgentType

        void setRunOnAgentType​(@NotNull
                               SAgentType agentType)
        Assigns build to the specified agent. If both pool and agent are set, agent will have higher precedence.
        Parameters:
        agent - agent where to start build
      • getAgentTypeToRunOn

        @Nullable
        SAgentType getAgentTypeToRunOn()
      • setMoveToTheQueueTop

        void setMoveToTheQueueTop​(boolean moveToTop)
        Set to true if build must be moved to the queue top.
        Parameters:
        moveToTop - true to move build to the queue top, false by default.
      • isMoveToTheQueueTop

        boolean isMoveToTheQueueTop()
        Returns:
        true if build must be moved to the top of the queue.
      • setCollectChangesEarly

        void setCollectChangesEarly​(boolean collectChangesEarly)
        Set to true to start changes collecting right after the build is added to the queue.
        Parameters:
        collectChangesEarly - true to collect changes after adding to the queue.
      • isCollectChangesEarly

        boolean isCollectChangesEarly()
        Returns:
        true if changes must be collected after adding to the queue.