Package jenkins.agents

Interface IOfflineCause

All Known Implementing Classes:
DiskSpaceMonitorDescriptor.DiskSpace, MonitorOfflineCause, OfflineCause, OfflineCause.ByCLI, OfflineCause.ChannelTermination, OfflineCause.IdleOfflineCause, OfflineCause.LaunchFailed, OfflineCause.LegacyOfflineCause, OfflineCause.SimpleOfflineCause, OfflineCause.UserCause, ResponseTimeMonitor.Data, SimpleScheduledRetentionStrategy.ScheduledOfflineCause, TcpSlaveAgentListener.ConnectionFromCurrentPeer
public interface IOfflineCause
Represents a cause that puts a computer offline.
Since:
2.483

  • Method Details

    • getComputerIcon

      @NonNull default String getComputerIcon()
      Returns:
      The icon to use for the computer that has this offline cause. It will be displayed in the build executor status widget, as well as in nodes list screen.

    • getComputerIconAltText

      @NonNull default String getComputerIconAltText()
      Returns:
      The alt text for the icon returned by getComputerIcon().

    • getIcon

      @NonNull default String getIcon()
      Returns:
      The icon to render this offline cause. It will be displayed in the build executor status widget.

    • getReason

      @NonNull default String getReason()
      Returns:
      The reason why this offline cause exists.

      For implementers: this can use HTML formatting, so make sure to only include trusted content.

    • getMessage

      @NonNull default String getMessage()
      Returns:
      A short message (one word) that summarizes the offline cause.

      For implementers: this can use HTML formatting, so make sure to only include trusted content.

    • getStatusClass

      default String getStatusClass()
      Returns:
      the CSS class name that should be used to render the status.

    • getTimestamp

      long getTimestamp()
      Timestamp in which the event happened.

    • getTime

      @NonNull default Date getTime()
      Same as getTimestamp() but in a different type.