class OvirtSDK4::DomainsService

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

Public Instance Methods

domain_service(id) click to toggle source

Reference to a service to view details of a domain.

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

@return [DomainService] A reference to the `domain` service.

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

List all the authentication domains in the system.

Usage:

.… GET /ovirt-engine/api/domains .…

Will return the list of domains:

source,xml

<domains>

<domain href="/ovirt-engine/api/domains/5678" id="5678">
  <name>internal-authz</name>
  <link href="/ovirt-engine/api/domains/5678/users" rel="users"/>
  <link href="/ovirt-engine/api/domains/5678/groups" rel="groups"/>
  <link href="/ovirt-engine/api/domains/5678/users?search={query}" rel="users/search"/>
  <link href="/ovirt-engine/api/domains/5678/groups?search={query}" rel="groups/search"/>
</domain>

</domains>


@param opts [Hash] Additional options.

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

@return [Array<Domain>]

# File lib/ovirtsdk4/services.rb, line 7524
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 DomainReader.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 7564
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return domain_service(path)
  end
  return domain_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 7580
def to_s
  "#<#{DomainsService}:#{@path}>"
end