Package io.jenkins.plugins.checks.steps

Class ChecksInfo

java.lang.Object

io.jenkins.plugins.checks.steps.ChecksInfo

All Implemented Interfaces:

Serializable

public class ChecksInfo
extends Object
implements Serializable

A collection of checks properties that will be injected into WithChecksStep closure.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ChecksInfo(String name)	Creates a ChecksInfo with checks name.
ChecksInfo(String name, String detailsURL)	Creates a ChecksInfo with checks name and optional details URL.

Method Summary

Modifier and Type	Method	Description
String	getDetailsURL()	Gets the custom details URL.
String	getName()

Methods inherited from class java.lang.Object

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

Constructor Details

ChecksInfo

public ChecksInfo(String name)

Creates a ChecksInfo with checks name.

Parameters:

name - the name of the check

ChecksInfo

public ChecksInfo(String name,
 @CheckForNull
 String detailsURL)

Creates a ChecksInfo with checks name and optional details URL.

Parameters:

name - the name of the check

detailsURL - the custom details URL (optional, can be null)

Method Details

getName

public String getName()

getDetailsURL

@CheckForNull
public String getDetailsURL()

Gets the custom details URL.

Returns:

the custom details URL, or null if not set