class OvirtSDK4::StepsService
Public Class Methods
Creates a new implementation of the service.
@param connection [Connection] The connection to be used by this service.
@param path [String] The relative path of this service, for example `vms/123/disks`.
@api private
# File lib/ovirtsdk4/services.rb, line 18250 def initialize(connection, path) @connection = connection @path = path end
Public Instance Methods
Adds a new `step`.
@param step [Step]
@return [Step]
# File lib/ovirtsdk4/services.rb, line 18262 def add(step, opts = {}) if step.is_a?(Hash) step = OvirtSDK4::Step.new(step) end request = Request.new(:method => :POST, :path => @path) begin writer = XmlWriter.new(nil, true) StepWriter.write_one(step, writer, 'step') request.body = writer.string ensure writer.close end response = @connection.send(request) case response.code when 201, 202 begin reader = XmlReader.new(response.body) return StepReader.read_one(reader) ensure reader.close end else check_fault(response) end end
Returns the representation of the object managed by this service.
@param opts [Hash] Additional options.
@option opts [Integer] :max Sets the maximum number of steps to return. If not specified all the steps are returned.
@return [Array<Step>]
# File lib/ovirtsdk4/services.rb, line 18297 def list(opts = {}) query = {} value = opts[:max] unless value.nil? value = Writer.render_integer(value) query['max'] = value end request = Request.new(:method => :GET, :path => @path, :query => query) response = @connection.send(request) case response.code when 200 begin reader = XmlReader.new(response.body) return StepReader.read_many(reader) ensure reader.close end else check_fault(response) end 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 18337 def service(path) if path.nil? || path == '' return self end index = path.index('/') if index.nil? return step_service(path) end return step_service(path[0..(index - 1)]).service(path[(index +1)..-1]) end
Locates the `step` service.
@param id [String] The identifier of the `step`.
@return [StepService] A reference to the `step` service.
# File lib/ovirtsdk4/services.rb, line 18326 def step_service(id) return StepService.new(@connection, "#{@path}/#{id}") end
Returns an string representation of this service.
@return [String]
# File lib/ovirtsdk4/services.rb, line 18353 def to_s return "#<#{StepsService}:#{@path}>" end