Interface JobApi
-
public interface JobApi
Provides the job functionalities
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
cancelJob(CancelJobRequest request)
Cancels given job.boolean
exists(UUID jobId)
Returns true if a job with given ID exists.PagedResponse<Job>
findJobs(FindJobsRequest findRequest)
Find the jobs with the given filter settings.Job
getJob(UUID jobId)
Returns the job for the given ID.
-
-
-
Method Detail
-
getJob
Job getJob(UUID jobId)
Returns the job for the given ID.- Parameters:
jobId
- the ID of the job- Returns:
- the job linked to the given ID
-
findJobs
@SecurityAuditMethod(resultFormatter=PagedResponseFormatter.class) PagedResponse<Job> findJobs(FindJobsRequest findRequest)
Find the jobs with the given filter settings.- Parameters:
findRequest
- the parameter defining which jobs to return.- Returns:
- The found jobs.
-
cancelJob
void cancelJob(CancelJobRequest request)
Cancels given job. This method will return immediately and not wait until the job is actually stopped.- Parameters:
request
- the properties of this cancel request
-
exists
boolean exists(UUID jobId)
Returns true if a job with given ID exists.- Parameters:
jobId
- the ID of the job- Returns:
- true if a job with given ID exists,
false
otherwise
-
-