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
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 class jenkins.model.TransientActionFactory
TransientActionFactory.Cache
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 -
Method Summary
Modifier and TypeMethodDescriptiondoDescribe
(boolean fullStages) doIndex()
void
doInputSubmit
(String inputId) static String
getArtifactsUrl
(org.jenkinsci.plugins.workflow.job.WorkflowRun run) 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) 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
-
Constructor Details
-
RunAPI
public RunAPI()
-
-
Method Details
-
getUrl
-
getDescribeUrl
-
getChangeSetsUrl
-
getPendingInputActionsUrl
-
getNextPendingInputActionUrl
public static String getNextPendingInputActionUrl(org.jenkinsci.plugins.workflow.job.WorkflowRun run) -
getArtifactsUrl
-
getInputStepSubmitUrl
-
getArtifactUrl
-
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
-