Class: OvirtSDK4::ExternalHostProvidersService

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(provider, opts = {}) ⇒ ExternalHostProvider

Add a new external host provider to the system.

Parameters:

  • provider (ExternalHostProvider) —

    The provider 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:



9783
9784
9785
 
# File 'lib/ovirtsdk4/services.rb', line 9783

def add(provider, opts = {})
  internal_add(provider, ExternalHostProvider, ADD, opts)
end

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

Returns the list of external host providers.

The order of the returned list of host providers 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 providers to return. If not specified all the providers are returned.

  • :search (String) —

    A query string used to restrict the returned external host providers.

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



9820
9821
9822
 
# File 'lib/ovirtsdk4/services.rb', line 9820

def list(opts = {})
  internal_get(LIST, opts)
end

#provider_service(id) ⇒ ExternalHostProviderService

Locates the provider service.

Parameters:

  • id (String) —

    The identifier of the provider.

Returns:



9831
9832
9833
 
# File 'lib/ovirtsdk4/services.rb', line 9831

def provider_service(id)
  ExternalHostProviderService.new(self, id)
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.



9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
 
# File 'lib/ovirtsdk4/services.rb', line 9842

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