class OvirtSDK4::ImageTransfersService

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

Public Instance Methods

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

Add a new image transfer. An image needs to be specified in order to make a new transfer.

@param image_transfer [ImageTransfer] The `image_transfer` to add.

@param opts [Hash] Additional options.

@return [ImageTransfer]

# File lib/ovirtsdk4/services.rb, line 12267
def add(image_transfer, opts = {})
  if image_transfer.is_a?(Hash)
    image_transfer = OvirtSDK4::ImageTransfer.new(image_transfer)
  end
  query = {}
  request = HttpRequest.new(method: :POST, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    ImageTransferWriter.write_one(image_transfer, 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 ImageTransferReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
image_transfer_service(id) click to toggle source

Returns a reference to the service that manages an specific image transfer.

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

@return [ImageTransferService] A reference to the `image_transfer` service.

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

Retrieves the list of image transfers that are currently being performed.

@param opts [Hash] Additional options.

@return [Array<ImageTransfer>]

# File lib/ovirtsdk4/services.rb, line 12302
def list(opts = {})
  query = {}
  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 ImageTransferReader.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 12338
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return image_transfer_service(path)
  end
  return image_transfer_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 12354
def to_s
  "#<#{ImageTransfersService}:#{@path}>"
end