Package com.cloudbees.workflow.rest.endpoints

Class JobAPI

java.lang.Object

jenkins.model.TransientActionFactory<T>

com.cloudbees.workflow.rest.AbstractAPIActionHandler<org.jenkinsci.plugins.workflow.job.WorkflowJob>

com.cloudbees.workflow.rest.AbstractWorkflowJobActionHandler

com.cloudbees.workflow.rest.endpoints.JobAPI

All Implemented Interfaces:

ExtensionPoint, Action, ModelObject

@Extension
public class JobAPI
extends AbstractWorkflowJobActionHandler

API Action handler to return WorkflowJob info.

Bound to ${{rootURL}/job/<jobname>/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
JobAPI()

Method Summary

Modifier and Type	Method	Description
JobExt	doDescribe()
JobExt	doIndex()
List<RunExt>	doRuns(String since, boolean fullStages)	Get all Workflow Job runs/builds since the specified run/build name.
static String	getDescribeUrl(org.jenkinsci.plugins.workflow.job.WorkflowJob job)
static String	getRunsUrl(org.jenkinsci.plugins.workflow.job.WorkflowJob job)
static String	getUrl(org.jenkinsci.plugins.workflow.job.WorkflowJob job)

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

createFor, getJob, 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

JobAPI

public JobAPI()

Method Detail

getUrl

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

getDescribeUrl

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

getRunsUrl

public static String getRunsUrl(org.jenkinsci.plugins.workflow.job.WorkflowJob job)

doRuns

public List<RunExt> doRuns(@QueryParameter
                           String since,
                           @QueryParameter
                           boolean fullStages)

Get all Workflow Job runs/builds since the specified run/build name.

Parameters:

since - The run/build name at which to stop returning (inclusive), or null/empty if all runs/builds are to be returned.

fullStages - Return the stageNodes within each stage

Returns:

The runs list.

doIndex

public JobExt doIndex()

doDescribe

public JobExt doDescribe()