Package net.bluemind.scheduledjob.api

Interface IJob

All Known Subinterfaces:
IInCoreJob
@Path("/scheduledjobs") public interface IJob

  • Method Details

    • searchJob

      @POST @Path("_searchJob") ListResult<Job> searchJob(JobQuery query) throws ServerFault
      List jobs deployed. global invalid input: '&' non-global admins will get different results.
      Parameters:
      query -
      Returns:
      Throws:
      ServerFault

    • searchExecution

      @POST @Path("_searchExecution") ListResult<JobExecution> searchExecution(JobExecutionQuery query) throws ServerFault
      Fetch recorded job executions. Pagination is supported. global invalid input: '&' non-global admins will get different results.
      Parameters:
      query -
      Returns:
      list of job executions, sorted by start execution date in descending order
      Throws:
      ServerFault

    • getJobFromId

      @GET @Path("_job/{jobId}") Job getJobFromId(@PathParam("jobId") String jobId) throws ServerFault
      Get job using its id
      Parameters:
      jobId -
      Returns:
      Throws:
      ServerFault

    • update

      @POST @Path("_updateJob") void update(Job job) throws ServerFault
      Update job planification JobPlanification
      Parameters:
      job -
      Throws:
      ServerFault

    • deleteExecution

      @DELETE @Path("_deleteExecution") void deleteExecution(@QueryParam("jobExecutionId") int jobExecutionId) throws ServerFault
      Removes one execution. Removes nothing if your token has no right on this execution (global job, different domain, etc)
      Parameters:
      execution -
      Throws:
      ServerFault

    • deleteExecutions

      @DELETE @Path("_deleteExecutions") void deleteExecutions(List<Integer> executions) throws ServerFault
      Removes multiple executions.
      Parameters:
      execution -
      Throws:
      ServerFault

    • start

      @POST @Path("_start/{jobId}") void start(@PathParam("jobId") String jobId, @QueryParam("domainName") String domainName) throws ServerFault
      Get active job using its ID force-start a job. Execution is recorded when the job finishes.
      Parameters:
      jobId -
      Throws:
      ServerFault

    • cancel

      @DELETE @Path("_cancel/{jobId}") void cancel(@PathParam("jobId") String jobId, @QueryParam("domainName") String domainName) throws ServerFault
      Cancel running job by its ID
      Parameters:
      jobId -
      Throws:
      ServerFault

    • getLogs

      @POST @Path("_logs") Set<LogEntry> getLogs(JobExecution jobExecution, @QueryParam("offset") int offset) throws ServerFault
      Return the logs of a job. The offset indicates how much logs you already fetched in a previous call.
      Parameters:
      offset -
      execution -
      Returns:
      Throws:
      ServerFault