net.bluemind.scheduledjob.api

Interface IJob

All Known Subinterfaces:

IInCoreJob

All Known Implementing Classes:

ScheduledJobService

@Path(value="/scheduledjobs")
public interface IJob

Method Summary

Modifier and Type	Method and Description
void	cancel(java.lang.String jobId, java.lang.String domainName) Cancel running job by its ID
void	deleteExecution(int jobExecutionId) Removes one execution.
void	deleteExecutions(java.util.List<java.lang.Integer> executions) Removes multiple executions.
Job	getJobFromId(java.lang.String jobId) Get job using its id
java.util.Set<LogEntry>	getLogs(JobExecution jobExecution, int offset) Return the logs of a job.
ListResult<JobExecution>	searchExecution(JobExecutionQuery query) Fetch recorded job executions.
ListResult<Job>	searchJob(JobQuery query) List jobs deployed.
void	start(java.lang.String jobId, java.lang.String domainName) Get active job using its ID force-start a job.
void	update(Job job) Update job planification JobPlanification

Method Detail

searchJob

@POST
 @Path(value="_searchJob")
ListResult<Job> searchJob(JobQuery query)
                                                    throws ServerFault

List jobs deployed. global & non-global admins will get different results.

Parameters:

query -

Returns:

Throws:

ServerFault

searchExecution

@POST
 @Path(value="_searchExecution")
ListResult<JobExecution> searchExecution(JobExecutionQuery query)
                                                                         throws ServerFault

Fetch recorded job executions. Pagination is supported. global & 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(value="_job/{jobId}")
Job getJobFromId(@PathParam(value="jobId")
                                                   java.lang.String jobId)
                                            throws ServerFault

Get job using its id

Parameters:

jobId -

Returns:

Throws:

ServerFault

update

@POST
 @Path(value="_updateJob")
void update(Job job)
                                      throws ServerFault

Update job planification JobPlanification

Parameters:

job -

Throws:

ServerFault

deleteExecution

@DELETE
 @Path(value="_deleteExecution")
void deleteExecution(@QueryParam(value="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(value="_deleteExecutions")
void deleteExecutions(java.util.List<java.lang.Integer> executions)
                                                         throws ServerFault

Removes multiple executions.

Parameters:

execution -

Throws:

ServerFault

start

@POST
 @Path(value="_start/{jobId}")
void start(@PathParam(value="jobId")
                                                java.lang.String jobId,
                                                @QueryParam(value="domainName")
                                                java.lang.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(value="_cancel/{jobId}")
void cancel(@PathParam(value="jobId")
                                                    java.lang.String jobId,
                                                    @QueryParam(value="domainName")
                                                    java.lang.String domainName)
                                             throws ServerFault

Cancel running job by its ID

Parameters:

jobId -

Throws:

ServerFault

getLogs

@POST
 @Path(value="_logs")
java.util.Set<LogEntry> getLogs(JobExecution jobExecution,
                                                            @QueryParam(value="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:

execution -

offset -

Returns:

Throws:

ServerFault