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 aFlowNode
to signify that some non-fatal event occurred during execution of aStep
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 wasresult
.
-
-
Constructor Summary
Constructors Constructor Description WarningAction(Result result)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDisplayName()
String
getIconFileName()
String
getMessage()
Result
getResult()
String
getUrlName()
WarningAction
withMessage(String message)
-
-
-
Constructor Detail
-
WarningAction
public WarningAction(@NonNull Result result)
-
-
Method Detail
-
withMessage
public WarningAction withMessage(String message)
-
getMessage
@CheckForNull public String getMessage()
-
getResult
@NonNull public Result getResult()
-
getDisplayName
public String getDisplayName()
- Specified by:
getDisplayName
in interfaceAction
- Specified by:
getDisplayName
in interfaceModelObject
-
getIconFileName
public String getIconFileName()
- Specified by:
getIconFileName
in interfaceAction
-
getUrlName
public String getUrlName()
- Specified by:
getUrlName
in interfaceAction
-
-