Class: OvirtSDK4::IconsService

Inherits:
Service
  • Object
show all
Defined in:
lib/ovirtsdk4/services.rb,
lib/ovirtsdk4/services.rb

Instance Method Summary collapse

Methods inherited from Service

#inspect, #to_s

Instance Method Details

#icon_service(id) ⇒ IconService

Reference to the service that manages an specific icon.

Parameters:

  • id (String)

    The identifier of the icon.

Returns:


12876
12877
12878
# File 'lib/ovirtsdk4/services.rb', line 12876

def icon_service(id)
  IconService.new(self, id)
end

#list(opts = {}) ⇒ Array<Icon>

Get a list of icons.

GET /ovirt-engine/api/icons

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

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

The order of the returned list of icons isn’t guaranteed.

Parameters:

  • opts (Hash) (defaults to: {})

    Additional options.

Options Hash (opts):

  • :follow (String)

    Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.

  • :max (Integer)

    Sets the maximum number of icons to return. If not specified all the icons are returned.

  • :headers (Hash) — default: {}

    Additional HTTP headers.

  • :query (Hash) — default: {}

    Additional URL query parameters.

  • :timeout (Integer) — default: 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.

  • :wait (Boolean) — default: true

    If true wait for the response.

Returns:


12865
12866
12867
# File 'lib/ovirtsdk4/services.rb', line 12865

def list(opts = {})
  internal_get(LIST, opts)
end

#service(path) ⇒ Service

Locates the service corresponding to the given path.

Parameters:

  • path (String)

    The path of the service.

Returns:

  • (Service)

    A reference to the service.


12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
# File 'lib/ovirtsdk4/services.rb', line 12887

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