io.jenkins.plugins.pipeline.restful.api

Class PipelineRestfulAPI

java.lang.Object

jenkins.model.TransientActionFactory<T>

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

com.cloudbees.workflow.rest.AbstractWorkflowJobActionHandler

io.jenkins.plugins.pipeline.restful.api.PipelineRestfulAPI

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Action, hudson.model.ModelObject

@Extension
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class PipelineRestfulAPI
extends com.cloudbees.workflow.rest.AbstractWorkflowJobActionHandler

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static String	URL_BASE

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

target

Constructor Summary

Constructors

Constructor and Description
PipelineRestfulAPI()

Method Summary

Modifier and Type	Method and Description
hudson.model.Queue.WaitingItem	_doBuild(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, hudson.model.ParametersDefinitionProperty pp, hudson.model.Cause cause, jenkins.util.TimeDuration delay) Interprets the form submission and schedules a build for a parameterized job.
org.kohsuke.stapler.HttpResponse	doAddParameter(org.kohsuke.stapler.StaplerRequest req)
void	doBuild(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, jenkins.util.TimeDuration delay)
Pipeline	doIndex()
org.kohsuke.stapler.HttpResponse	doRemoveParameter(String params)
org.kohsuke.stapler.HttpResponse	doUpdate(String script)
org.jenkinsci.plugins.workflow.job.WorkflowRun	findBuild(org.jenkinsci.plugins.workflow.job.WorkflowJob job, String uuid)
static hudson.model.CauseAction	getBuildCause(jenkins.model.ParameterizedJobMixIn.ParameterizedJob job, org.kohsuke.stapler.StaplerRequest req) Computes the build cause, using RemoteCause or UserCause as appropriate.
hudson.model.ParameterDefinition	getParameterDefinition(hudson.model.ParametersDefinitionProperty pp, String name) Gets the ParameterDefinition of the given name, if any.
static String	getUrl(org.jenkinsci.plugins.workflow.job.WorkflowJob job)
String	getUrlName()

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

createFor, getJob, type

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

getDisplayName, getIconFileName

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

Field Detail

URL_BASE

public static final String URL_BASE

See Also:

Constant Field Values

Constructor Detail

PipelineRestfulAPI

public PipelineRestfulAPI()

Method Detail

getUrl

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

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface hudson.model.Action

Overrides:

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

doIndex

public Pipeline doIndex()

doUpdate

public org.kohsuke.stapler.HttpResponse doUpdate(@QueryParameter
                                                 String script)
                                          throws IOException

Throws:

IOException

doAddParameter

public org.kohsuke.stapler.HttpResponse doAddParameter(org.kohsuke.stapler.StaplerRequest req)

doRemoveParameter

public org.kohsuke.stapler.HttpResponse doRemoveParameter(@QueryParameter
                                                          String params)

doBuild

public void doBuild(org.kohsuke.stapler.StaplerRequest req,
                    org.kohsuke.stapler.StaplerResponse rsp,
                    @QueryParameter
                    jenkins.util.TimeDuration delay)
             throws IOException,
                    javax.servlet.ServletException,
                    InterruptedException

Throws:

IOException

javax.servlet.ServletException

InterruptedException

findBuild

public org.jenkinsci.plugins.workflow.job.WorkflowRun findBuild(org.jenkinsci.plugins.workflow.job.WorkflowJob job,
                                                                String uuid)

_doBuild

public hudson.model.Queue.WaitingItem _doBuild(org.kohsuke.stapler.StaplerRequest req,
                                               org.kohsuke.stapler.StaplerResponse rsp,
                                               hudson.model.ParametersDefinitionProperty pp,
                                               hudson.model.Cause cause,
                                               @QueryParameter
                                               jenkins.util.TimeDuration delay)
                                        throws IOException,
                                               javax.servlet.ServletException

Interprets the form submission and schedules a build for a parameterized job.

This method is supposed to be invoked from ParameterizedJobMixIn.doBuild(StaplerRequest, StaplerResponse, TimeDuration).

Returns:

Throws:

IOException

javax.servlet.ServletException

getParameterDefinition

@CheckForNull
public hudson.model.ParameterDefinition getParameterDefinition(hudson.model.ParametersDefinitionProperty pp,
                                                                             String name)

Gets the ParameterDefinition of the given name, if any.

getBuildCause

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static hudson.model.CauseAction getBuildCause(jenkins.model.ParameterizedJobMixIn.ParameterizedJob job,
                                                                                                                            org.kohsuke.stapler.StaplerRequest req)

Computes the build cause, using RemoteCause or UserCause as appropriate.