Package hudson.slaves

Class OfflineCause.UserCause

java.lang.Object

hudson.slaves.OfflineCause

hudson.slaves.OfflineCause.SimpleOfflineCause

hudson.slaves.OfflineCause.UserCause

All Implemented Interfaces:

IOfflineCause

Direct Known Subclasses:

OfflineCause.ByCLI

Enclosing class:

OfflineCause

public static class OfflineCause.UserCause
extends OfflineCause.SimpleOfflineCause

Taken offline by user.

Since:

1.551

Nested Class Summary

Nested classes/interfaces inherited from class hudson.slaves.OfflineCause

OfflineCause.ByCLI, OfflineCause.ChannelTermination, OfflineCause.IdleOfflineCause, OfflineCause.LaunchFailed, OfflineCause.LegacyOfflineCause, OfflineCause.SimpleOfflineCause, OfflineCause.UserCause

Field Summary

Fields inherited from class hudson.slaves.OfflineCause.SimpleOfflineCause

description

Fields inherited from class hudson.slaves.OfflineCause

timestamp

Constructor Summary

Constructors

Constructor	Description
UserCause(User user, String message)

Method Summary

Modifier and Type	Method	Description
String	getComputerIcon()
String	getComputerIconAltText()
String	getIcon()
String	getMessage()
User	getUser()

Methods inherited from class hudson.slaves.OfflineCause.SimpleOfflineCause

toString

Methods inherited from class hudson.slaves.OfflineCause

create, getTimestamp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jenkins.agents.IOfflineCause

getReason, getStatusClass, getTime

Constructor Details

UserCause

public UserCause(@CheckForNull
 User user,
 @CheckForNull
 String message)

Method Details

getUser

public User getUser()

getMessage

public String getMessage()

Returns:

the message that was provided when the computer was taken offline

getComputerIcon

@NonNull
public 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
public String getComputerIconAltText()

Returns:

The alt text for the icon returned by IOfflineCause.getComputerIcon().

getIcon

@NonNull
public String getIcon()

Returns:

The icon to render this offline cause. It will be displayed in the build executor status widget.