Package com.cloudbees.workflow.rest.endpoints

Class RunAPI

java.lang.Object
jenkins.model.TransientActionFactory<T>
com.cloudbees.workflow.rest.AbstractAPIActionHandler<org.jenkinsci.plugins.workflow.job.WorkflowRun>
com.cloudbees.workflow.rest.AbstractWorkflowRunActionHandler
com.cloudbees.workflow.rest.endpoints.RunAPI
All Implemented Interfaces:
ExtensionPoint, Action, ModelObject
@Extension public class RunAPI extends AbstractWorkflowRunActionHandler
API Action handler to return a single WorkflowJob run.

Bound to ${{rootURL}/job/<jobname>/<runId>/wfapi/*}

Author:
tom.fennelly@gmail.com

  • Constructor Details

    • RunAPI

      public RunAPI()

  • Method Details

    • getUrl

      public static String getUrl(org.jenkinsci.plugins.workflow.job.WorkflowRun run)

    • getDescribeUrl

      public static String getDescribeUrl(org.jenkinsci.plugins.workflow.job.WorkflowRun run)

    • getChangeSetsUrl

      public static String getChangeSetsUrl(org.jenkinsci.plugins.workflow.job.WorkflowRun run)

    • getPendingInputActionsUrl

      public static String getPendingInputActionsUrl(org.jenkinsci.plugins.workflow.job.WorkflowRun run)

    • getNextPendingInputActionUrl

      public static String getNextPendingInputActionUrl(org.jenkinsci.plugins.workflow.job.WorkflowRun run)

    • getArtifactsUrl

      public static String getArtifactsUrl(org.jenkinsci.plugins.workflow.job.WorkflowRun run)

    • getInputStepSubmitUrl

      public static String getInputStepSubmitUrl(org.jenkinsci.plugins.workflow.job.WorkflowRun run, String inputId)

    • getArtifactUrl

      public static String getArtifactUrl(org.jenkinsci.plugins.workflow.job.WorkflowRun run, Run<org.jenkinsci.plugins.workflow.job.WorkflowJob,org.jenkinsci.plugins.workflow.job.WorkflowRun>.Artifact artifact)

    • doIndex

      @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public RunExt doIndex()

    • doDescribe

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public RunExt doDescribe(@QueryParameter boolean fullStages)
      Parameters:
      fullStages - Return the stageNodes within each stage

    • doChangesets

      @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public List<ChangeSetExt> doChangesets()

    • doPendingInputActions

      @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public List<PendingInputActionsExt> doPendingInputActions()

    • doNextPendingInputAction

      @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public PendingInputActionsExt doNextPendingInputAction()

    • doArtifacts

      @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public List<BuildArtifactExt> doArtifacts()

    • doInputSubmit

      @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public void doInputSubmit(@QueryParameter String inputId) throws jakarta.servlet.ServletException
      Throws:
      jakarta.servlet.ServletException