Package io.jenkins.plugins.checks.api
Class ChecksAction
- java.lang.Object
-
- io.jenkins.plugins.checks.api.ChecksAction
-
public class ChecksAction extends Object
An action of a check. It can be used to create actions like re-run or automatic formatting.
-
-
Constructor Summary
Constructors Constructor Description ChecksAction(String label, String description, String identifier)
Creates aChecksAction
using the given parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Optional<String>
getDescription()
Optional<String>
getIdentifier()
Optional<String>
getLabel()
String
toString()
-
-
-
Constructor Detail
-
ChecksAction
public ChecksAction(@CheckForNull String label, @CheckForNull String description, @CheckForNull String identifier)
Creates aChecksAction
using the given parameters.Note that for a GitHub check run, the
label
,description
, andidentifier
must not exceed 20, 40, and 20 characters.- Parameters:
label
- the text to be displayed on a button in web UIdescription
- a short explanation of what this action would doidentifier
- a reference for the action on the integrator's system
-
-