Class: OvirtSDK4::ImageTransferService

Inherits:

Service

• Object
• Service
• OvirtSDK4::ImageTransferService

Defined in:

lib/ovirtsdk4/services.rb,
lib/ovirtsdk4/services.rb

Instance Method Summary

• #cancel(opts = {}) ⇒ Object

  Cancel the image transfer session.

• #extend(opts = {}) ⇒ Object

  Extend the image transfer session.

• #finalize(opts = {}) ⇒ Object

  After finishing to transfer the data, finalize the transfer.

• #get(opts = {}) ⇒ ImageTransfer

  Get the image transfer entity.

• #pause(opts = {}) ⇒ Object

  Pause the image transfer session.

• #resume(opts = {}) ⇒ Object

  Resume the image transfer session.

• #service(path) ⇒ Service

  Locates the service corresponding to the given path.

Methods inherited from Service

#inspect, #to_s

Instance Method Details

#cancel(opts = {}) ⇒ Object

Cancel the image transfer session. This terminates the transfer operation and removes the partial image.

Parameters:

• opts (Hash) (defaults to: {}) —

  Additional options.

Options Hash (opts):

• :headers (Hash) — default: {} —

  Additional HTTP headers.

• :query (Hash) — default: {} —

  Additional URL query parameters.

• :timeout (Integer) — default: nil —

  The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.

• :wait (Boolean) — default: true —

  If true wait for the response.

# File 'lib/ovirtsdk4/services.rb', line 13107

def cancel(opts = {})
  internal_action(:cancel, nil, CANCEL, opts)
end

#extend(opts = {}) ⇒ Object

Extend the image transfer session.

Parameters:

• opts (Hash) (defaults to: {}) —

  Additional options.

Options Hash (opts):

• :headers (Hash) — default: {} —

  Additional HTTP headers.

• :query (Hash) — default: {} —

  Additional URL query parameters.

• :timeout (Integer) — default: nil —

  The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.

• :wait (Boolean) — default: true —

  If true wait for the response.

# File 'lib/ovirtsdk4/services.rb', line 13130

def extend(opts = {})
  internal_action(:extend, nil, EXTEND, opts)
end

#finalize(opts = {}) ⇒ Object

After finishing to transfer the data, finalize the transfer.

This will make sure that the data being transferred is valid and fits the image entity that was targeted in the transfer. Specifically, will verify that if the image entity is a QCOW disk, the data uploaded is indeed a QCOW file, and that the image doesn’t have a backing file.

Parameters:

• opts (Hash) (defaults to: {}) —

  Additional options.

Options Hash (opts):

• :headers (Hash) — default: {} —

  Additional HTTP headers.

• :query (Hash) — default: {} —

  Additional URL query parameters.

• :timeout (Integer) — default: nil —

  The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.

• :wait (Boolean) — default: true —

  If true wait for the response.

# File 'lib/ovirtsdk4/services.rb', line 13158

def finalize(opts = {})
  internal_action(:finalize, nil, FINALIZE, opts)
end

#get(opts = {}) ⇒ ImageTransfer

Get the image transfer entity.

Parameters:

• opts (Hash) (defaults to: {}) —

  Additional options.

Options Hash (opts):

• :follow (String) —

  Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.

• :headers (Hash) — default: {} —

  Additional HTTP headers.

• :query (Hash) — default: {} —

  Additional URL query parameters.

• :timeout (Integer) — default: nil —

  The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.

• :wait (Boolean) — default: true —

  If true wait for the response.

Returns:

• (ImageTransfer)

# File 'lib/ovirtsdk4/services.rb', line 13187

def get(opts = {})
  internal_get(GET, opts)
end

#pause(opts = {}) ⇒ Object

Pause the image transfer session.

Parameters:

• opts (Hash) (defaults to: {}) —

  Additional options.

Options Hash (opts):

• :headers (Hash) — default: {} —

  Additional HTTP headers.

• :query (Hash) — default: {} —

  Additional URL query parameters.

• :timeout (Integer) — default: nil —

  The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.

• :wait (Boolean) — default: true —

  If true wait for the response.

# File 'lib/ovirtsdk4/services.rb', line 13210

def pause(opts = {})
  internal_action(:pause, nil, PAUSE, opts)
end

#resume(opts = {}) ⇒ Object

Resume the image transfer session. The client will need to poll the transfer’s phase until it is different than resuming. For example:

transfer_service = transfers_service.image_transfer_service(transfer.id)
transfer_service.resume()
transfer = transfer_service.get()

while transfer.phase == types.ImageTransferPhase.RESUMING:
   time.sleep(1)
   transfer = transfer_service.get()

Parameters:

• opts (Hash) (defaults to: {}) —

  Additional options.

Options Hash (opts):

• :headers (Hash) — default: {} —

  Additional HTTP headers.

• :query (Hash) — default: {} —

  Additional URL query parameters.

• :timeout (Integer) — default: nil —

  The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.

• :wait (Boolean) — default: true —

  If true wait for the response.

# File 'lib/ovirtsdk4/services.rb', line 13244

def resume(opts = {})
  internal_action(:resume, nil, RESUME, opts)
end

#service(path) ⇒ Service

Locates the service corresponding to the given path.

Parameters:

• path (String) —

  The path of the service.

Returns:

• (Service) —

  A reference to the service.

Raises:

• (Error)

# File 'lib/ovirtsdk4/services.rb', line 13255

def service(path)
  if path.nil? || path == ''
    return self
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end