class OvirtSDK4::AffinityLabelService

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

Public Instance Methods

get(opts = {}) click to toggle source

Retrieves the details of a label.

@param opts [Hash] Additional options.

@option opts [Hash] :headers Additional HTTP headers.

@option opts [Hash] :query Additional URL query parameters.

@return [AffinityLabel]

# File lib/ovirtsdk4/services.rb, line 1325
def get(opts = {})
  headers = opts[:headers] || {}
  query = opts[:query] || {}
  request = HttpRequest.new(method: :GET, url: @path, headers: headers, query: query)
  response = @connection.send(request)
  case response.code
  when 200
    begin
      reader = XmlReader.new(response.body)
      return AffinityLabelReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
hosts_service() click to toggle source

List all hosts with this label.

@return [AffinityLabelHostsService] A reference to `hosts` service.

# File lib/ovirtsdk4/services.rb, line 1410
def hosts_service
  AffinityLabelHostsService.new(@connection, "#{@path}/hosts")
end
remove(opts = {}) click to toggle source

Removes a label from the system and clears all assignments of the removed label.

@param opts [Hash] Additional options.

@option opts [Hash] :headers Additional HTTP headers.

@option opts [Hash] :query Additional URL query parameters.

# File lib/ovirtsdk4/services.rb, line 1353
def remove(opts = {})
  headers = opts[:headers] || {}
  query = opts[:query] || {}
  request = HttpRequest.new(method: :DELETE, url: @path, headers: headers, query: query)
  response = @connection.send(request)
  unless response.code == 200
    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 1430
def service(path)
  if path.nil? || path == ''
    return self
  end
  if path == 'hosts'
    return hosts_service
  end
  if path.start_with?('hosts/')
    return hosts_service.service(path[6..-1])
  end
  if path == 'vms'
    return vms_service
  end
  if path.start_with?('vms/')
    return vms_service.service(path[4..-1])
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 1454
def to_s
  "#<#{AffinityLabelService}:#{@path}>"
end
update(label, opts = {}) click to toggle source

Updates a label. This call will update all metadata, such as the name or description.

@param label [AffinityLabel] The `label` to update. @param opts [Hash] Additional options.

@option opts [Hash] :headers Additional HTTP headers.

@option opts [Hash] :query Additional URL query parameters.

@return [AffinityLabel]

# File lib/ovirtsdk4/services.rb, line 1376
def update(label, opts = {})
  if label.is_a?(Hash)
    label = OvirtSDK4::AffinityLabel.new(label)
  end
  headers = opts[:headers] || {}
  query = opts[:query] || {}
  request = HttpRequest.new(method: :PUT, url: @path, headers: headers, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    AffinityLabelWriter.write_one(label, writer)
    request.body = writer.string
  ensure
    writer.close
  end
  response = @connection.send(request)
  case response.code
  when 200
    begin
      reader = XmlReader.new(response.body)
      return AffinityLabelReader.read_one(reader)
    ensure
      reader.close
    end
    return result
  else
    check_fault(response)
  end
end
vms_service() click to toggle source

List all virtual machines with this label.

@return [AffinityLabelVmsService] A reference to `vms` service.

# File lib/ovirtsdk4/services.rb, line 1419
def vms_service
  AffinityLabelVmsService.new(@connection, "#{@path}/vms")
end