com.cdancy.jenkins.rest.features

Interface JobsApi

@Path(value="/")
public interface JobsApi

Method Summary

Modifier and Type	Method and Description
IntegerResponse	build(java.lang.String optionalFolderPath, java.lang.String jobName)
BuildInfo	buildInfo(java.lang.String optionalFolderPath, java.lang.String jobName, int buildNumber)
IntegerResponse	buildWithParameters(java.lang.String optionalFolderPath, java.lang.String jobName, java.util.Map<java.lang.String,java.util.List<java.lang.String>> properties)
java.lang.String	config(java.lang.String optionalFolderPath, java.lang.String jobName)
boolean	config(java.lang.String optionalFolderPath, java.lang.String jobName, java.lang.String configXML)
RequestStatus	create(java.lang.String optionalFolderPath, java.lang.String jobName, java.lang.String configXML)
RequestStatus	delete(java.lang.String optionalFolderPath, java.lang.String jobName)
java.lang.String	description(java.lang.String optionalFolderPath, java.lang.String jobName)
boolean	description(java.lang.String optionalFolderPath, java.lang.String jobName, java.lang.String description)
boolean	disable(java.lang.String optionalFolderPath, java.lang.String jobName)
boolean	enable(java.lang.String optionalFolderPath, java.lang.String jobName)
JobInfo	jobInfo(java.lang.String optionalFolderPath, java.lang.String jobName)
JobList	jobList(java.lang.String folderPath)
java.lang.Integer	lastBuildNumber(java.lang.String optionalFolderPath, java.lang.String jobName)
java.lang.String	lastBuildTimestamp(java.lang.String optionalFolderPath, java.lang.String jobName)
PipelineNode	pipelineNode(java.lang.String optionalFolderPath, java.lang.String jobName, int buildNumber, int nodeId)
ProgressiveText	progressiveText(java.lang.String optionalFolderPath, java.lang.String jobName, int start)
ProgressiveText	progressiveText(java.lang.String optionalFolderPath, java.lang.String jobName, int buildNumber, int start)
boolean	rename(java.lang.String optionalFolderPath, java.lang.String jobName, java.lang.String newName)
Workflow	workflow(java.lang.String optionalFolderPath, java.lang.String jobName, int buildNumber)

Method Detail

jobList

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

jobInfo

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

buildInfo

@Named(value="jobs:build-info")
 @Path(value="{optionalFolderPath}job/{name}/{number}/api/json")
 @Consumes(value="application/json")
 @GET
BuildInfo buildInfo(@Nullable @PathParam(value="optionalFolderPath")
                                                                                                                                                                java.lang.String optionalFolderPath,
                                                                                                                                                                @PathParam(value="name")
                                                                                                                                                                java.lang.String jobName,
                                                                                                                                                                @PathParam(value="number")
                                                                                                                                                                int buildNumber)

create

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

config

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

config

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

description

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

description

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

delete

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

enable

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

disable

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

build

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

buildWithParameters

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

lastBuildNumber

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

lastBuildTimestamp

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

progressiveText

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

progressiveText

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

rename

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

workflow

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

pipelineNode

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