Class: OvirtSDK4::TemplateGraphicsConsolesService

Inherits:
Service
  • Object
show all
Defined in:
lib/ovirtsdk4/services.rb,
lib/ovirtsdk4/services.rb

Instance Method Summary collapse

Methods inherited from Service

#inspect, #to_s

Instance Method Details

#add(console, opts = {}) ⇒ GraphicsConsole

Add new graphics console to the template.

Parameters:

  • console (GraphicsConsole)

    The console to add.

  • 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.

Returns:


27710
27711
27712
# File 'lib/ovirtsdk4/services.rb', line 27710

def add(console, opts = {})
  internal_add(console, GraphicsConsole, ADD, opts)
end

#console_service(id) ⇒ TemplateGraphicsConsoleService

Returns a reference to the service that manages a specific template graphics console.

Parameters:

  • id (String)

    The identifier of the console.

Returns:


27755
27756
27757
# File 'lib/ovirtsdk4/services.rb', line 27755

def console_service(id)
  TemplateGraphicsConsoleService.new(self, id)
end

#list(opts = {}) ⇒ Array<GraphicsConsole>

Lists all the configured graphics consoles of the template.

The order of the returned list of graphics consoles isn’t guaranteed.

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.

  • :max (Integer)

    Sets the maximum number of consoles to return. If not specified all the consoles are returned.

  • :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:


27744
27745
27746
# File 'lib/ovirtsdk4/services.rb', line 27744

def list(opts = {})
  internal_get(LIST, 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.


27766
27767
27768
27769
27770
27771
27772
27773
27774
27775
# File 'lib/ovirtsdk4/services.rb', line 27766

def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return console_service(path)
  end
  return console_service(path[0..(index - 1)]).service(path[(index + 1)..-1])
end