Class: OvirtSDK4::JobService
- Defined in:
- lib/ovirtsdk4/services.rb,
lib/ovirtsdk4/services.rb
Instance Method Summary collapse
-
#clear(opts = {}) ⇒ Object
Set an external job execution to be cleared by the system.
-
#end_(opts = {}) ⇒ Object
Marks an external job execution as ended.
-
#get(opts = {}) ⇒ Job
Retrieves a job.
-
#service(path) ⇒ Service
Locates the service corresponding to the given path.
-
#steps_service ⇒ StepsService
List all the steps of the job.
Methods inherited from Service
Instance Method Details
#clear(opts = {}) ⇒ Object
Set an external job execution to be cleared by the system.
For example, to set a job with identifier 123
send the following request:
POST /ovirt-engine/api/jobs/clear
With the following request body:
<action/>
13701 13702 13703 |
# File 'lib/ovirtsdk4/services.rb', line 13701 def clear(opts = {}) internal_action(:clear, nil, CLEAR, opts) end |
#end_(opts = {}) ⇒ Object
Marks an external job execution as ended.
For example, to terminate a job with identifier 123
send the following request:
POST /ovirt-engine/api/jobs/end
With the following request body:
<action>
<force>true</force>
<status>finished</status>
</action>
13752 13753 13754 |
# File 'lib/ovirtsdk4/services.rb', line 13752 def end_(opts = {}) internal_action(:end, nil, END_, opts) end |
#get(opts = {}) ⇒ Job
Retrieves a job.
GET /ovirt-engine/api/jobs/123
You will receive response in XML like this one:
<job href="/ovirt-engine/api/jobs/123" id="123">
<actions>
<link href="/ovirt-engine/api/jobs/123/clear" rel="clear"/>
<link href="/ovirt-engine/api/jobs/123/end" rel="end"/>
</actions>
<description>Adding Disk</description>
<link href="/ovirt-engine/api/jobs/123/steps" rel="steps"/>
<auto_cleared>true</auto_cleared>
<end_time>2016-12-12T23:07:29.758+02:00</end_time>
<external>false</external>
<last_updated>2016-12-12T23:07:29.758+02:00</last_updated>
<start_time>2016-12-12T23:07:26.593+02:00</start_time>
<status>failed</status>
<owner href="/ovirt-engine/api/users/456" id="456"/>
</job>
13807 13808 13809 |
# File 'lib/ovirtsdk4/services.rb', line 13807 def get(opts = {}) internal_get(GET, opts) end |
#service(path) ⇒ Service
Locates the service corresponding to the given path.
13829 13830 13831 13832 13833 13834 13835 13836 13837 13838 13839 13840 |
# File 'lib/ovirtsdk4/services.rb', line 13829 def service(path) if path.nil? || path == '' return self end if path == 'steps' return steps_service end if path.start_with?('steps/') return steps_service.service(path[6..-1]) end raise Error.new("The path \"#{path}\" doesn't correspond to any service") end |
#steps_service ⇒ StepsService
List all the steps of the job.
The order of the returned list of steps isn’t guaranteed.
13818 13819 13820 |
# File 'lib/ovirtsdk4/services.rb', line 13818 def steps_service @steps_service ||= StepsService.new(self, 'steps') end |