Class: OvirtSDK4::FiltersService

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

Add a filter to a specified user defined scheduling policy.

Parameters:

  • filter (Filter)

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


10763
10764
10765
# File 'lib/ovirtsdk4/services.rb', line 10763

def add(filter, opts = {})
  internal_add(filter, Filter, ADD, opts)
end

#filter_service(id) ⇒ FilterService

Locates the filter service.

Parameters:

  • id (String)

    The identifier of the filter.

Returns:


10811
10812
10813
# File 'lib/ovirtsdk4/services.rb', line 10811

def filter_service(id)
  FilterService.new(self, id)
end

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

Returns the list of filters used by the scheduling policy.

The order of the returned list of filters isn’t guaranteed.

Parameters:

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

    Additional options.

Options Hash (opts):

  • :filter (Boolean)

    Indicates if the results should be filtered according to the permissions of the user.

  • :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 filters to return. If not specified all the filters 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:


10800
10801
10802
# File 'lib/ovirtsdk4/services.rb', line 10800

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.


10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
# File 'lib/ovirtsdk4/services.rb', line 10822

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