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

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.cloudbees.workflow.rest.AbstractAPIActionHandler

target, URL_BASE

Constructor Summary

Constructors

Constructor	Description
RunAPI()

Method Summary

Modifier and Type	Method	Description
List<BuildArtifactExt>	doArtifacts()
List<ChangeSetExt>	doChangesets()
RunExt	doDescribe(boolean fullStages)
RunExt	doIndex()
void	doInputSubmit(String inputId)
PendingInputActionsExt	doNextPendingInputAction()
List<PendingInputActionsExt>	doPendingInputActions()
static String	getArtifactsUrl(org.jenkinsci.plugins.workflow.job.WorkflowRun run)
static String	getArtifactUrl(org.jenkinsci.plugins.workflow.job.WorkflowRun run, Run.Artifact artifact)
static String	getChangeSetsUrl(org.jenkinsci.plugins.workflow.job.WorkflowRun run)
static String	getDescribeUrl(org.jenkinsci.plugins.workflow.job.WorkflowRun run)
static String	getInputStepSubmitUrl(org.jenkinsci.plugins.workflow.job.WorkflowRun run, String inputId)
static String	getNextPendingInputActionUrl(org.jenkinsci.plugins.workflow.job.WorkflowRun run)
static String	getPendingInputActionsUrl(org.jenkinsci.plugins.workflow.job.WorkflowRun run)
static String	getUrl(org.jenkinsci.plugins.workflow.job.WorkflowRun run)

Methods inherited from class com.cloudbees.workflow.rest.AbstractWorkflowRunActionHandler

createFor, getRun, type

Methods inherited from class com.cloudbees.workflow.rest.AbstractAPIActionHandler

getDisplayName, getIconFileName, getUrlName

Methods inherited from class jenkins.model.TransientActionFactory

actionType, factoriesFor

Methods inherited from class java.lang.Object

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

Constructor Detail

RunAPI

public RunAPI()

Method Detail

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.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 javax.servlet.ServletException

Throws:

javax.servlet.ServletException