Package org.xwiki.rest.resources.job
Interface JobsResource
-
public interface JobsResource- Since:
- 9.1RC1
- Version:
- $Id: 5a7ffc66d9104c938dfaab917316a67b7d8f5d93 $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description JobStatusexecuteJob(String jobType, boolean async, JobRequest jobRequest)Start a new Job.
-
-
-
Field Detail
-
NAME
static final String NAME
The entry name of the resource.- See Also:
- Constant Field Values
-
-
Method Detail
-
executeJob
JobStatus executeJob(String jobType, boolean async, JobRequest jobRequest) throws XWikiRestException
Start a new Job.- Parameters:
jobType- the type of the job to startasync- true if the REST request should return without waiting for the end of the jobjobRequest- the request controlling job behavior- Returns:
- the newly created job status
- Throws:
XWikiRestException- when failing to start job
-
-