Package org.jenkinsci.plugins.ParameterizedRemoteTrigger.remoteJob

Enum RemoteBuildStatus

java.lang.Object
java.lang.Enum<RemoteBuildStatus>
org.jenkinsci.plugins.ParameterizedRemoteTrigger.remoteJob.RemoteBuildStatus
All Implemented Interfaces:
Serializable, Comparable<RemoteBuildStatus>
public enum RemoteBuildStatus extends Enum<RemoteBuildStatus>
This class implements the build status of a remote build. 

 NOT_TRIGGERED --+--> QUEUED --+--> RUNNING --+--> FINISHED
                          |                              |
                          |                              |
                          +-------> Cancelled <----------+

By default, the remote build status is NOT_TRIGGERED.

When the remote build is triggered, the remote job enters the queue (waiting list) and the status of the remote build changes to QUEUED.

When the remote job leaves the queue, the status changes to RUNNING.

When the remote job is finished, the status changes to FINISHED. This is the final status. In addition, at the status QUEUED and FINISHED, a remote build can be cancelled, in this case an AbortException is thrown.

  • Enum Constant Details

    • NOT_TRIGGERED

      public static final RemoteBuildStatus NOT_TRIGGERED
      The remote job was not triggered and it did not enter the queue.

    • QUEUED

      public static final RemoteBuildStatus QUEUED
      The remote job was triggered and it did enter the queue.

    • RUNNING

      public static final RemoteBuildStatus RUNNING
      The remote job left the queue and it is running currently.

    • FINISHED

      public static final RemoteBuildStatus FINISHED
      The remote build is finished.

  • Method Details

    • values

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

    • valueOf

      public static RemoteBuildStatus valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<RemoteBuildStatus>