Package org.xwiki.rest.resources.job
Interface JobStatusResource
-
public interface JobStatusResource
- Since:
- 7.2M3
- Version:
- $Id: 0d0c63206715814ef918c631c92c51ec6fb3b9f8 $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description JobStatus
getJobStatus(String jobId, boolean request, boolean progress, boolean log, String logFromLevel)
Find and return the status of the running job (of the stored status if the job is finished).
-
-
-
Field Detail
-
NAME
static final String NAME
The entry name of the resource.- Since:
- 8.0
- See Also:
- Constant Field Values
-
-
Method Detail
-
getJobStatus
JobStatus getJobStatus(String jobId, boolean request, boolean progress, boolean log, String logFromLevel) throws XWikiRestException
Find and return the status of the running job (of the stored status if the job is finished).- Parameters:
jobId
- the identifier of the jobrequest
- ifTrue
the job request should be serialized in the status (since 9.1RC1)progress
- ifTrue
the job progress should be serialized in the status (since 9.1RC1)log
- ifTrue
the job log should be serialized in the status (since 9.1RC1)logFromLevel
- the level of the log to filter from- Returns:
- the job status
- Throws:
XWikiRestException
- when failing to search job
-
-