class OvirtSDK4::AffinityLabelsService

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

Public Instance Methods

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

Creates a new label. The label is automatically attached to all entities mentioned in the vms or hosts lists.

@param label [AffinityLabel] The `label` to add.

@param opts [Hash] Additional options.

@return [AffinityLabel]

# File lib/ovirtsdk4/services.rb, line 1825
def add(label, opts = {})
  if label.is_a?(Hash)
    label = OvirtSDK4::AffinityLabel.new(label)
  end
  query = {}
  request = HttpRequest.new(method: :POST, url: @path, 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, 201, 202
    begin
      reader = XmlReader.new(response.body)
      return AffinityLabelReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
label_service(id) click to toggle source

Link to a single label details.

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

@return [AffinityLabelService] A reference to the `label` service.

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

Lists all labels present in the system.

@param opts [Hash] Additional options.

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

@return [Array<AffinityLabel>]

# File lib/ovirtsdk4/services.rb, line 1861
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 AffinityLabelReader.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 1901
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return label_service(path)
  end
  return label_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 1917
def to_s
  "#<#{AffinityLabelsService}:#{@path}>"
end