class OvirtSDK4::TemplatesService
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 22823 def initialize(connection, path) @connection = connection @path = path end
Public Instance Methods
Adds a new `template`.
@param template [Template]
@return [Template]
# File lib/ovirtsdk4/services.rb, line 22835 def add(template, opts = {}) if template.is_a?(Hash) template = OvirtSDK4::Template.new(template) end request = Request.new(:method => :POST, :path => @path) begin writer = XmlWriter.new(nil, true) TemplateWriter.write_one(template, writer) 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 TemplateReader.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 [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into
account. The default value is `true`, which means that case is taken into account. If you want to search ignoring case set it to `false`.
@option opts [Boolean] :filter Indicates if the results should be filtered according to the permissions of the user.
@option opts [Integer] :max Sets the maximum number of templates to return. If not specified all the templates are returned.
@option opts [String] :search A query string used to restrict the returned templates.
@return [Array<Template>]
# File lib/ovirtsdk4/services.rb, line 22878 def list(opts = {}) query = {} value = opts[:case_sensitive] unless value.nil? value = Writer.render_boolean(value) query['case_sensitive'] = value end value = opts[:filter] unless value.nil? value = Writer.render_boolean(value) query['filter'] = value end value = opts[:max] unless value.nil? value = Writer.render_integer(value) query['max'] = value end value = opts[:search] unless value.nil? query['search'] = 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 TemplateReader.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 22932 def service(path) if path.nil? || path == '' return self end index = path.index('/') if index.nil? return template_service(path) end return template_service(path[0..(index - 1)]).service(path[(index +1)..-1]) end
Locates the `template` service.
@param id [String] The identifier of the `template`.
@return [TemplateService] A reference to the `template` service.
# File lib/ovirtsdk4/services.rb, line 22921 def template_service(id) return TemplateService.new(@connection, "#{@path}/#{id}") end
Returns an string representation of this service.
@return [String]
# File lib/ovirtsdk4/services.rb, line 22948 def to_s return "#<#{TemplatesService}:#{@path}>" end