Package io.jenkins.plugins.batchcontrol.ops

Enum Class NotificationEvent

java.lang.Object
java.lang.Enum<NotificationEvent>
io.jenkins.plugins.batchcontrol.ops.NotificationEvent
All Implemented Interfaces:
Serializable, Comparable<NotificationEvent>, Constable
public enum NotificationEvent extends Enum<NotificationEvent>
The request events a BatchControlNotifier receives (SPEC item 13, D-36).

Recipients: the designated approvers for REQUEST_CREATED and APPROVERS_CHANGED; for the end events of D-54 see CANCELLED, EXPIRED and INVALIDATED; the requester for every other event.

  • Enum Constant Details

    • REQUEST_CREATED

      public static final NotificationEvent REQUEST_CREATED
      A run or change request was created and waits for a decision.

    • APPROVERS_CHANGED

      public static final NotificationEvent APPROVERS_CHANGED
      The requester changed the designated approver set of a pending request.

    • APPROVED

      public static final NotificationEvent APPROVED
      A designated approver approved the request.

    • REJECTED

      public static final NotificationEvent REJECTED
      A designated approver rejected the request.

    • EXPIRING

      public static final NotificationEvent EXPIRING
      A pending run or change request reaches its pending timeout soon.

    • GRANT_EXPIRING

      public static final NotificationEvent GRANT_EXPIRING
      An active change window (grant) ends soon.

    • CANCELLED

      public static final NotificationEvent CANCELLED
      A pending request was cancelled (D-54). Sent to its designated approvers, and to the requester only when someone else (a Manage holder) cancelled it; never to the canceller.

    • EXPIRED

      public static final NotificationEvent EXPIRED
      A request expired (D-54): pending past its timeout, or approved but not started in time. Sent to the requester, with the reason, and to the designated approvers when it was pending.

    • INVALIDATED

      public static final NotificationEvent INVALIDATED
      A request was invalidated (D-54), for example because its job was renamed or deleted. Sent to the requester, with the reason, and to the designated approvers when it was pending.

  • Method Details

    • values

      public static NotificationEvent[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static NotificationEvent valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getTitle

      public String getTitle()
      Short human-readable title used in plain-text messages.