Class: OvirtSDK4::AssignedAffinityLabelsService

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

Attaches a label to an entity.

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:


2426
2427
2428
# File 'lib/ovirtsdk4/services.rb', line 2426

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

#label_service(id) ⇒ AssignedAffinityLabelService

Link to the specific entity-label assignment to allow removal.

Parameters:

  • id (String)

    The identifier of the label.

Returns:


2469
2470
2471
# File 'lib/ovirtsdk4/services.rb', line 2469

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

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

Lists all labels that are attached to an entity.

The order of the returned entities 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.

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


2457
2458
2459
# File 'lib/ovirtsdk4/services.rb', line 2457

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.


2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
# File 'lib/ovirtsdk4/services.rb', line 2480

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