Package org.jenkinsci.plugins.workflow.actions

Class WarningAction

java.lang.Object

org.jenkinsci.plugins.workflow.actions.WarningAction

All Implemented Interfaces:

Action, ModelObject, PersistentAction

public class WarningAction
extends Object
implements PersistentAction

Action to be attached to a FlowNode to signify that some non-fatal event occurred during execution of a Step but execution continued normally. withMessage(java.lang.String) should be used whenever possible to give context to the warning. Visualizations should treat FlowNodes with this action as if the FlowNode's result was result.

Constructor Summary

Constructors

Constructor	Description
WarningAction(Result result)

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()
String	getIconFileName()
String	getMessage()
Result	getResult()
String	getUrlName()
WarningAction	withMessage(String message)

Methods inherited from class java.lang.Object

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

Constructor Details

WarningAction

public WarningAction(@NonNull
 Result result)

Method Details

withMessage

public WarningAction withMessage(String message)

getMessage

@CheckForNull
public String getMessage()

getResult

@NonNull
public Result getResult()

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action