class OvirtSDK4::JobService
Constants
- CLEAR
- END_
- GET
Public Instance Methods
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
<action/>
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the action should be performed asynchronously.
@option opts [Hash] :headers ({}) Additional HTTP headers.
@option opts [Hash] :query ({}) Additional URL query parameters.
@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
given then the timeout set globally for the connection will be used.
@option opts [Boolean] :wait (true) If `true` wait for the response.
# File lib/ovirtsdk4/services.rb, line 14974 def clear(opts = {}) internal_action(:clear, nil, CLEAR, opts) 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
<action>
<force>true</force> <status>finished</status>
</action>
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the action should be performed asynchronously.
@option opts [Boolean] :force Indicates if the job should be forcibly terminated.
@option opts [Boolean] :succeeded Indicates if the job should be marked as successfully finished or as failed.
This parameter is optional, and the default value is `true`.
@option opts [Hash] :headers ({}) Additional HTTP headers.
@option opts [Hash] :query ({}) Additional URL query parameters.
@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
given then the timeout set globally for the connection will be used.
@option opts [Boolean] :wait (true) If `true` wait for the response.
# File lib/ovirtsdk4/services.rb, line 15025 def end_(opts = {}) internal_action(:end, nil, END_, opts) end
Retrieves a job.
- source
GET
/ovirt-engine/api/jobs/123
You will receive response in XML like this one:
- source,xml
<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>
@param opts [Hash] Additional options.
@option opts [String] :follow Indicates which inner links should be followed. The objects referenced by these links will be fetched as part
of the current request. See <<documents/003_common_concepts/follow, here>> for details.
@option opts [Hash] :headers ({}) Additional HTTP headers.
@option opts [Hash] :query ({}) Additional URL query parameters.
@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
given then the timeout set globally for the connection will be used.
@option opts [Boolean] :wait (true) If `true` wait for the response.
@return [Job]
# File lib/ovirtsdk4/services.rb, line 15080 def get(opts = {}) internal_get(GET, opts) end
Locates the service corresponding to the given path.
@param path [String] The path of the service.
@return [Service] A reference to the service.
# File lib/ovirtsdk4/services.rb, line 15102 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
List
all the steps of the job.
The order of the returned list of steps isn't guaranteed.
@return [StepsService] A reference to `steps` service.
# File lib/ovirtsdk4/services.rb, line 15091 def steps_service @steps_service ||= StepsService.new(self, 'steps') end