Package io.jenkins.plugins.batchcontrol.policy

Class EndReasons

java.lang.Object

io.jenkins.plugins.batchcontrol.policy.EndReasons

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public final class EndReasons
extends Object

The reason texts of requests that end without a decision (e2e-04 FD-05, D-54). An expired request carries the reason in its decision comment, which the request pages show as "Why it expired"; the same text goes into the EXPIRED notification.

Method Summary

Modifier and Type	Method	Description
static String	approvedNotStarted()	An approved run request did not start within the approved-run timeout.
static String	approvedRunCancelled()	D-72b (7): an approved run request whose queue item was cancelled, so it did not start within the approved-run timeout and is never submitted again.
static String	pendingExpired()	A pending request passed the pending timeout.
static String	withEarlierComment(String reason, String earlierComment)	The decision comment of an expired request: the reason, followed by an approver's earlier comment when there is one (it is kept, not replaced).

Methods inherited from class java.lang.Object

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

Method Details

pendingExpired

public static String pendingExpired()

A pending request passed the pending timeout.

approvedNotStarted

public static String approvedNotStarted()

An approved run request did not start within the approved-run timeout.

approvedRunCancelled

public static String approvedRunCancelled()

D-72b (7): an approved run request whose queue item was cancelled, so it did not start within the approved-run timeout and is never submitted again.

withEarlierComment

public static String withEarlierComment(String reason,
 String earlierComment)

The decision comment of an expired request: the reason, followed by an approver's earlier comment when there is one (it is kept, not replaced).