Package com.atlassian.bamboo.v2.build.agent

Interface BuildAgent

All Superinterfaces:
BambooIdProvider, Comparable<BuildAgent>, NameProvider
All Known Subinterfaces:
LocalBuildAgent
All Known Implementing Classes:
BuildAgentDecorator, BuildAgentImpl, LocalBuildAgentImpl
public interface BuildAgent extends Comparable<BuildAgent>, NameProvider, BambooIdProvider
Represents a UI view of a given build agent

  • Field Details

  • Method Details

    • getId

      long getId()
      Specified by:
      getId in interface BambooIdProvider

    • getName

      @NotNull @NotNull String getName()
      Specified by:
      getName in interface NameProvider

    • getType

      AgentType getType()

    • isActive

      boolean isActive()

    • isEnabled

      boolean isEnabled()

    • getAgentStatus

      @NotNull @NotNull AgentStatus getAgentStatus()

    • getDefinition

      @NotNull @NotNull PipelineDefinition getDefinition()

    • setDefinition

      void setDefinition(@NotNull @NotNull PipelineDefinition definition)

    • isRequestedToBeStopped

      boolean isRequestedToBeStopped()
      Whether or not a call has been made to shutdown the agent after the current build has finished
      Returns:

    • setRequestedToBeStopped

      void setRequestedToBeStopped(boolean requestedToBeStopped)

    • accept

      void accept(BuildAgent.BuildAgentVisitor buildAgentVisitor)
      Runs the appropriate visitor method depending on which type of agent it is
      Parameters:
      buildAgentVisitor -

    • isUnresponsive

      boolean isUnresponsive()
      Whether or not the agent has been deemed to be "unresponsive". Agents will be first marked as unresponsive before they are made offline.

      Used for remote agents.

      Returns:

    • setUnresponsive

      void setUnresponsive(boolean unresponsive)

    • isBusy

      boolean isBusy()
      Returns true if an agent is building or is cancelling a build
      Returns:

    • isDedicated

      @Deprecated boolean isDedicated()
      Deprecated.
      without replacement; this is temporary solution