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

Interface AgentStatus

All Known Implementing Classes:
AbstractAgentStatus, AbstractBuildAwareAgentStatus, AgentBuildingStatus, AgentCancellingStatus, AgentIdleStatus, AgentOfflineStatus
public interface AgentStatus
What the agent is doing?

  • Method Details

    • getOrderIndex

      int getOrderIndex()
      Used to order the AgentStatus

    • getLabel

      @NotNull @NotNull String getLabel()
      Returns:
      the label to display

    • getImagePath

      @Deprecated @NotNull @NotNull String getImagePath()
      Deprecated.
      since 9.0. Use getIcon() with @ui.icon ftl template.
      Returns:
      The image to use for this status

    • getIcon

      @NotNull @NotNull String getIcon()
      Returns:
      the icon to use for this status

    • isAllowDelete

      boolean isAllowDelete()
      Returns:
      true if the agent is allowed to be deleted when in this state

    • getUrl

      @Nullable @Nullable String getUrl()
      Returns:
      The URL the status should point to. Will be prepended by the contextPath

    • getDisplayName

      @Nullable @Nullable String getDisplayName()
      Returns:
      The display name for the thing that agent is building. Use in the UI.

    • isIdle

      boolean isIdle()
      Returns true if the agent idle at present.
      Returns:
      agent idle status