Package org.ovirt.engine.sdk4.services
Interface JobService
-
- All Superinterfaces:
Service
- All Known Implementing Classes:
JobServiceImpl
public interface JobService extends Service
A service to manage a job.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
JobService.ClearRequest
Set an external job execution to be cleared by the system.static interface
JobService.ClearResponse
Set an external job execution to be cleared by the system.static interface
JobService.EndRequest
Marks an external job execution as ended.static interface
JobService.EndResponse
Marks an external job execution as ended.static interface
JobService.GetRequest
Retrieves a job.static interface
JobService.GetResponse
Retrieves a job.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description JobService.ClearRequest
clear()
Set an external job execution to be cleared by the system.JobService.EndRequest
end()
Marks an external job execution as ended.JobService.GetRequest
get()
Retrieves a job.Service
service(String path)
Service locator method, returns individual service on which the URI is dispatched.StepsService
stepsService()
List all the steps of the job.
-
-
-
Method Detail
-
clear
JobService.ClearRequest clear()
Set an external job execution to be cleared by the system. For example, to set a job with identifier `123` send the following request: [source] ---- POST /ovirt-engine/api/jobs/clear ---- With the following request body: [source,xml] --------
-
end
JobService.EndRequest end()
Marks an external job execution as ended. For example, to terminate a job with identifier `123` send the following request: [source] ---- POST /ovirt-engine/api/jobs/end ---- With the following request body: [source,xml] ----true finished
-
get
JobService.GetRequest get()
Retrieves a job. [source] ---- GET /ovirt-engine/api/jobs/123 ---- You will receive response in XML like this one: [source,xml] ----Adding Disk true 2016-12-12T23:07:29.758+02:00 false 2016-12-12T23:07:29.758+02:00 2016-12-12T23:07:26.593+02:00 failed
-
stepsService
StepsService stepsService()
List all the steps of the job. The order of the returned list of steps isn't guaranteed.
-
-