Package org.jenkinsci.plugins.ParameterizedRemoteTrigger.remoteJob

Class RemoteBuildInfo

java.lang.Object
org.jenkinsci.plugins.ParameterizedRemoteTrigger.remoteJob.RemoteBuildInfo
All Implemented Interfaces:
Serializable
public class RemoteBuildInfo extends Object implements Serializable
This class contains information about the remote build. 

 NOT_TRIGGERED ---+--->    QUEUED    --+-->    RUNNING    -----+----->         FINISHED
                             queueId           buildNumber                        result
                                                & buildURL              (ABORTED | UNSTABLE | FAILURE | SUCCESS)

By default, the remote build status is NOT_TRIGGERED and the remote build result is NOT_BUILT.

When the remote build is triggered, the remote job enters the queue (waiting list) and the status of the remote build changes to QUEUED. In this moment the queueId is available. The queueId can be used to request information about the remote job while it is waiting to be executed.

When the remote job leaves the queue, the status changes to RUNNING. Then, the build number and the build URL are available. The build URL can be used to request information about the remote job while it is being executed.

When the remote job is finished, the status changes to FINISHED. Then, the remote build result is available.

See Also:

  • Constructor Details

    • RemoteBuildInfo

      public RemoteBuildInfo()

  • Method Details

    • getQueueId

      @CheckForNull public String getQueueId()

    • getBuildNumber

      @NonNull public int getBuildNumber()

    • getBuildURL

      @CheckForNull public URL getBuildURL()

    • getStatus

      @NonNull public RemoteBuildStatus getStatus()

    • getResult

      @NonNull public Result getResult()

    • setQueueId

      public void setQueueId(String queueId)

    • setBuildData

      public void setBuildData(@NonNull int buildNumber, @Nullable URL buildURL) throws AbortException
      Throws:
      AbortException

    • setBuildStatus

      public void setBuildStatus(RemoteBuildStatus status)

    • setBuildResult

      public void setBuildResult(Result result)

    • setBuildResult

      public void setBuildResult(String result)

    • toString

      @NonNull public String toString()
      Overrides:
      toString in class Object

    • isNotTriggered

      public boolean isNotTriggered()

    • isQueued

      public boolean isQueued()

    • isRunning

      public boolean isRunning()

    • isFinished

      public boolean isFinished()