Class: OvirtSDK4::AffinityLabelsService

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

Creates a new label. The label is automatically attached to all entities mentioned in the vms or hosts lists.

Parameters:

  • label (AffinityLabel)

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


2244
2245
2246
# File 'lib/ovirtsdk4/services.rb', line 2244

def add(label, opts = {})
  internal_add(label, AffinityLabel, ADD, opts)
end

#label_service(id) ⇒ AffinityLabelService

Link to a single label details.

Parameters:

  • id (String)

    The identifier of the label.

Returns:


2289
2290
2291
# File 'lib/ovirtsdk4/services.rb', line 2289

def label_service(id)
  AffinityLabelService.new(self, id)
end

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

Lists all labels present in the system.

The order of the returned labels 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 labels to return. If not specified all the labels 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:


2278
2279
2280
# File 'lib/ovirtsdk4/services.rb', line 2278

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.


2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
# File 'lib/ovirtsdk4/services.rb', line 2300

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