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 and Description
ChecksAction(String label, String description, String identifier) Creates a ChecksAction using the given parameters.

Method Summary

Modifier and Type	Method and Description
Optional<String>	getDescription()
Optional<String>	getIdentifier()
Optional<String>	getLabel()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChecksAction

public ChecksAction(@CheckForNull
                    String label,
                    @CheckForNull
                    String description,
                    @CheckForNull
                    String identifier)

Creates a ChecksAction using the given parameters.

Note that for a GitHub check run, the label, description, and identifier must not exceed 20, 40, and 20 characters.

Parameters:

label - the text to be displayed on a button in web UI

description - a short explanation of what this action would do

identifier - a reference for the action on the integrator's system

Method Detail

getLabel

public Optional<String> getLabel()

getDescription

public Optional<String> getDescription()

getIdentifier

public Optional<String> getIdentifier()

toString

public String toString()

Overrides:

toString in class Object