Package com.cdancy.jenkins.rest.features

Interface JobsApi

@Path("/")
public interface JobsApi

Method Summary

Modifier and Type	Method	Description
InputStream	artifact(String optionalFolderPath, String jobName, int buildNumber, String relativeArtifactPath)
IntegerResponse	build(String optionalFolderPath, String jobName)
BuildInfo	buildInfo(String optionalFolderPath, String jobName, int buildNumber)
IntegerResponse	buildWithParameters(String optionalFolderPath, String jobName, Map<String,List<String>> properties)
String	config(String optionalFolderPath, String jobName)
boolean	config(String optionalFolderPath, String jobName, String configXML)
RequestStatus	create(String optionalFolderPath, String jobName, String configXML)
RequestStatus	delete(String optionalFolderPath, String jobName)
String	description(String optionalFolderPath, String jobName)
boolean	description(String optionalFolderPath, String jobName, String description)
boolean	disable(String optionalFolderPath, String jobName)
boolean	enable(String optionalFolderPath, String jobName)
JobInfo	jobInfo(String optionalFolderPath, String jobName)
JobList	jobList(String folderPath)
RequestStatus	kill(String optionalFolderPath, String jobName, int buildNumber)
Integer	lastBuildNumber(String optionalFolderPath, String jobName)
String	lastBuildTimestamp(String optionalFolderPath, String jobName)
PipelineNode	pipelineNode(String optionalFolderPath, String jobName, int buildNumber, int nodeId)
PipelineNodeLog	pipelineNodeLog(String optionalFolderPath, String jobName, int buildNumber, int nodeId)
ProgressiveText	progressiveText(String optionalFolderPath, String jobName, int start)
ProgressiveText	progressiveText(String optionalFolderPath, String jobName, int buildNumber, int start)
boolean	rename(String optionalFolderPath, String jobName, String newName)
List<Workflow>	runHistory(String optionalFolderPath, String jobName)
RequestStatus	stop(String optionalFolderPath, String jobName, int buildNumber)
RequestStatus	term(String optionalFolderPath, String jobName, int buildNumber)
com.google.gson.JsonObject	testReport(String optionalFolderPath, String jobName, int buildNumber)
Workflow	workflow(String optionalFolderPath, String jobName, int buildNumber)

Method Detail

jobList

@Named("jobs:get-jobs")
@Path("{folderPath}api/json")
@Consumes("application/json")
@GET
JobList jobList(@PathParam("folderPath")
                String folderPath)

jobInfo

@Named("jobs:job-info")
@Path("{optionalFolderPath}job/{name}/api/json")
@Consumes("application/json")
@GET
JobInfo jobInfo(@Nullable @PathParam("optionalFolderPath")
                String optionalFolderPath,
                @PathParam("name")
                String jobName)

buildInfo

@Named("jobs:artifact")
@Path("{optionalFolderPath}job/{name}/{number}/api/json")
@Consumes("application/json")
@GET
BuildInfo buildInfo(@Nullable @PathParam("optionalFolderPath")
                    String optionalFolderPath,
                    @PathParam("name")
                    String jobName,
                    @PathParam("number")
                    int buildNumber)

artifact

@Named("jobs:artifact")
@Path("{optionalFolderPath}job/{name}/{number}/artifact/{relativeArtifactPath}")
@Consumes("*/*")
@GET
InputStream artifact(@Nullable @PathParam("optionalFolderPath")
                     String optionalFolderPath,
                     @PathParam("name")
                     String jobName,
                     @PathParam("number")
                     int buildNumber,
                     @PathParam("relativeArtifactPath")
                     String relativeArtifactPath)

create

@Named("jobs:create")
@Path("{optionalFolderPath}createItem")
@Produces("application/xml")
@Consumes("*/*")
@POST
RequestStatus create(@Nullable @PathParam("optionalFolderPath")
                     String optionalFolderPath,
                     @QueryParam("name")
                     String jobName,
                     String configXML)

config

@Named("jobs:get-config")
@Path("{optionalFolderPath}job/{name}/config.xml")
@Consumes("text/plain")
@GET
String config(@Nullable @PathParam("optionalFolderPath")
              String optionalFolderPath,
              @PathParam("name")
              String jobName)

config

@Named("jobs:update-config")
@Path("{optionalFolderPath}job/{name}/config.xml")
@Produces("application/xml;charset=UTF-8")
@Consumes("text/html")
@POST
boolean config(@Nullable @PathParam("optionalFolderPath")
               String optionalFolderPath,
               @PathParam("name")
               String jobName,
               String configXML)

description

@Named("jobs:get-description")
@Path("{optionalFolderPath}job/{name}/description")
@Consumes("text/plain")
@GET
String description(@Nullable @PathParam("optionalFolderPath")
                   String optionalFolderPath,
                   @PathParam("name")
                   String jobName)

description

@Named("jobs:set-description")
@Path("{optionalFolderPath}job/{name}/description")
@Consumes("text/html")
@POST
boolean description(@Nullable @PathParam("optionalFolderPath")
                    String optionalFolderPath,
                    @PathParam("name")
                    String jobName,
                    @FormParam("description")
                    String description)

delete

@Named("jobs:delete")
@Path("{optionalFolderPath}job/{name}/doDelete")
@Consumes("text/html")
@POST
RequestStatus delete(@Nullable @PathParam("optionalFolderPath")
                     String optionalFolderPath,
                     @PathParam("name")
                     String jobName)

enable

@Named("jobs:enable")
@Path("{optionalFolderPath}job/{name}/enable")
@Consumes("text/html")
@POST
boolean enable(@Nullable @PathParam("optionalFolderPath")
               String optionalFolderPath,
               @PathParam("name")
               String jobName)

disable

@Named("jobs:disable")
@Path("{optionalFolderPath}job/{name}/disable")
@Consumes("text/html")
@POST
boolean disable(@Nullable @PathParam("optionalFolderPath")
                String optionalFolderPath,
                @PathParam("name")
                String jobName)

build

@Named("jobs:build")
@Path("{optionalFolderPath}job/{name}/build")
@Consumes("application/unknown")
@POST
IntegerResponse build(@Nullable @PathParam("optionalFolderPath")
                      String optionalFolderPath,
                      @PathParam("name")
                      String jobName)

stop

@Named("jobs:stop-build")
@Path("{optionalFolderPath}job/{name}/{number}/stop")
@Consumes("application/json")
@POST
RequestStatus stop(@Nullable @PathParam("optionalFolderPath")
                   String optionalFolderPath,
                   @PathParam("name")
                   String jobName,
                   @PathParam("number")
                   int buildNumber)

term

@Named("jobs:term-build")
@Path("{optionalFolderPath}job/{name}/{number}/term")
@Consumes("application/json")
@POST
RequestStatus term(@Nullable @PathParam("optionalFolderPath")
                   String optionalFolderPath,
                   @PathParam("name")
                   String jobName,
                   @PathParam("number")
                   int buildNumber)

kill

@Named("jobs:kill-build")
@Path("{optionalFolderPath}job/{name}/{number}/kill")
@Consumes("application/json")
@POST
RequestStatus kill(@Nullable @PathParam("optionalFolderPath")
                   String optionalFolderPath,
                   @PathParam("name")
                   String jobName,
                   @PathParam("number")
                   int buildNumber)

buildWithParameters

@Named("jobs:build-with-params")
@Path("{optionalFolderPath}job/{name}/buildWithParameters")
@Consumes("application/unknown")
@POST
IntegerResponse buildWithParameters(@Nullable @PathParam("optionalFolderPath")
                                    String optionalFolderPath,
                                    @PathParam("name")
                                    String jobName,
                                    @Nullable
                                    Map<String,List<String>> properties)

lastBuildNumber

@Named("jobs:last-build-number")
@Path("{optionalFolderPath}job/{name}/lastBuild/buildNumber")
@Consumes("text/plain")
@GET
Integer lastBuildNumber(@Nullable @PathParam("optionalFolderPath")
                        String optionalFolderPath,
                        @PathParam("name")
                        String jobName)

lastBuildTimestamp

@Named("jobs:last-build-timestamp")
@Path("{optionalFolderPath}job/{name}/lastBuild/buildTimestamp")
@Consumes("text/plain")
@GET
String lastBuildTimestamp(@Nullable @PathParam("optionalFolderPath")
                          String optionalFolderPath,
                          @PathParam("name")
                          String jobName)

progressiveText

@Named("jobs:progressive-text")
@Path("{optionalFolderPath}job/{name}/lastBuild/logText/progressiveText")
@Consumes("text/plain")
@GET
ProgressiveText progressiveText(@Nullable @PathParam("optionalFolderPath")
                                String optionalFolderPath,
                                @PathParam("name")
                                String jobName,
                                @QueryParam("start")
                                int start)

progressiveText

@Named("jobs:progressive-text")
@Path("{optionalFolderPath}job/{name}/{number}/logText/progressiveText")
@Consumes("text/plain")
@GET
ProgressiveText progressiveText(@Nullable @PathParam("optionalFolderPath")
                                String optionalFolderPath,
                                @PathParam("name")
                                String jobName,
                                @PathParam("number")
                                int buildNumber,
                                @QueryParam("start")
                                int start)

rename

@Named("jobs:rename")
@Path("{optionalFolderPath}job/{name}/doRename")
@Consumes("text/html")
@POST
boolean rename(@Nullable @PathParam("optionalFolderPath")
               String optionalFolderPath,
               @PathParam("name")
               String jobName,
               @QueryParam("newName")
               String newName)

runHistory

@Named("jobs:run-history")
@Path("{optionalFolderPath}job/{name}/wfapi/runs")
@Consumes("application/json")
@GET
List<Workflow> runHistory(@Nullable @PathParam("optionalFolderPath")
                          String optionalFolderPath,
                          @PathParam("name")
                          String jobName)

workflow

@Named("jobs:workflow")
@Path("{optionalFolderPath}job/{name}/{number}/wfapi/describe")
@Consumes("application/json")
@GET
Workflow workflow(@Nullable @PathParam("optionalFolderPath")
                  String optionalFolderPath,
                  @PathParam("name")
                  String jobName,
                  @PathParam("number")
                  int buildNumber)

pipelineNode

@Named("jobs:pipeline-node")
@Path("{optionalFolderPath}job/{name}/{number}/execution/node/{nodeId}/wfapi/describe")
@Consumes("application/json")
@GET
PipelineNode pipelineNode(@Nullable @PathParam("optionalFolderPath")
                          String optionalFolderPath,
                          @PathParam("name")
                          String jobName,
                          @PathParam("number")
                          int buildNumber,
                          @PathParam("nodeId")
                          int nodeId)

pipelineNodeLog

@Named("jobs:pipeline-node-log")
@Path("{optionalFolderPath}job/{name}/{number}/execution/node/{nodeId}/wfapi/log")
@Consumes("application/json")
@GET
PipelineNodeLog pipelineNodeLog(@Nullable @PathParam("optionalFolderPath")
                                String optionalFolderPath,
                                @PathParam("name")
                                String jobName,
                                @PathParam("number")
                                int buildNumber,
                                @PathParam("nodeId")
                                int nodeId)

testReport

@Named("jobs:testReport")
@Path("{optionalFolderPath}job/{name}/{number}/testReport/api/json")
@Consumes("application/json")
@GET
com.google.gson.JsonObject testReport(@Nullable @PathParam("optionalFolderPath")
                                      String optionalFolderPath,
                                      @PathParam("name")
                                      String jobName,
                                      @PathParam("number")
                                      int buildNumber)