class OvirtSDK4::PermitsService

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

Public Instance Methods

add(permit, opts = {}) click to toggle source

Adds a permit to the set aggregated by parent role. The permit must be one retrieved from the capabilities resource.

@param permit [Permit] The permit to add.

@param opts [Hash] Additional options.

@return [Permit]

# File lib/ovirtsdk4/services.rb, line 16170
def add(permit, opts = {})
  if permit.is_a?(Hash)
    permit = OvirtSDK4::Permit.new(permit)
  end
  query = {}
  request = Request.new(:method => :POST, :path => @path, :query => query)
  begin
    writer = XmlWriter.new(nil, true)
    PermitWriter.write_one(permit, 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 PermitReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
list(opts = {}) click to toggle source

Returns the representation of the object managed by this service.

@param opts [Hash] Additional options.

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

@return [Array<Permit>]

# File lib/ovirtsdk4/services.rb, line 16206
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 PermitReader.read_many(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
permit_service(id) click to toggle source

Sub-resource locator method, returns individual permit resource on which the remainder of the URI is dispatched.

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

@return [PermitService] A reference to the `permit` service.

# File lib/ovirtsdk4/services.rb, line 16235
def permit_service(id)
  return PermitService.new(@connection, "#{@path}/#{id}")
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 16246
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return permit_service(path)
  end
  return permit_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 16262
def to_s
  return "#<#{PermitsService}:#{@path}>"
end