class OvirtSDK4::IconsService

Public Class Methods

new(connection, path) click to toggle source

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 11861
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

icon_service(id) click to toggle source

Reference to the service that manages an specific icon.

@param id [String] The identifier of the `icon`.

@return [IconService] A reference to the `icon` service.

# File lib/ovirtsdk4/services.rb, line 11922
def icon_service(id)
  IconService.new(@connection, "#{@path}/#{id}")
end
list(opts = {}) click to toggle source

Get a list of icons.

source

GET /ovirt-engine/api/icons


You will get a XML response which is similar to this one:

source,xml

<icons>

<icon id="123">
  <data>...</data>
  <media_type>image/png</media_type>
</icon>
...

</icons>


@param opts [Hash] Additional options.

@option opts [Integer] :max Sets the maximum number of icons to return. If not specified all the icons are returned.

@return [Array<Icon>]

# File lib/ovirtsdk4/services.rb, line 11893
def list(opts = {})
  query = {}
  value = opts[:max]
  unless value.nil?
    value = Writer.render_integer(value)
    query['max'] = value
  end
  request = HttpRequest.new(method: :GET, url: @path, query: query)
  response = @connection.send(request)
  case response.code
  when 200
    begin
      reader = XmlReader.new(response.body)
      return IconReader.read_many(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
service(path) click to toggle source

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 11933
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return icon_service(path)
  end
  return icon_service(path[0..(index - 1)]).service(path[(index +1)..-1])
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 11949
def to_s
  "#<#{IconsService}:#{@path}>"
end