Package com.cdancy.jenkins.rest.features

Interface JobsApi

  • @Path("/")
public interface JobsApi

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method 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("jobs:get-jobs")
@Path("{folderPath}api/json")
@Consumes("application/json")
@GET
JobList jobList​(@PathParam("folderPath")
                java.lang.String folderPath)

      • jobInfo

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

      • buildInfo

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

      • create

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

      • config

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

      • config

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

      • description

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

      • description

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

      • delete

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

      • enable

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

      • disable

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

      • build

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

      • buildWithParameters

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

      • lastBuildNumber

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

      • lastBuildTimestamp

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

      • progressiveText

        @Named("jobs:progressive-text")
@Path("{optionalFolderPath}job/{name}/lastBuild/logText/progressiveText")
@Consumes("text/plain")
@GET
ProgressiveText progressiveText​(@Nullable @PathParam("optionalFolderPath")
                                java.lang.String optionalFolderPath,
                                @PathParam("name")
                                java.lang.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")
                                java.lang.String optionalFolderPath,
                                @PathParam("name")
                                java.lang.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")
               java.lang.String optionalFolderPath,
               @PathParam("name")
               java.lang.String jobName,
               @QueryParam("newName")
               java.lang.String newName)

      • workflow

        @Named("jobs:workflow")
@Path("{optionalFolderPath}job/{name}/{number}/wfapi/describe")
@Consumes("application/json")
@GET
Workflow workflow​(@Nullable @PathParam("optionalFolderPath")
                  java.lang.String optionalFolderPath,
                  @PathParam("name")
                  java.lang.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")
                          java.lang.String optionalFolderPath,
                          @PathParam("name")
                          java.lang.String jobName,
                          @PathParam("number")
                          int buildNumber,
                          @PathParam("nodeId")
                          int nodeId)