Class: OvirtSDK4::UserOptionService

Inherits:

Service

• Object
• Service
• OvirtSDK4::UserOptionService

Defined in:

lib/ovirtsdk4/services.rb,
lib/ovirtsdk4/services.rb

Instance Method Summary

• #get(opts = {}) ⇒ UserOption

  Returns a user profile property of type JSON.

• #remove(opts = {}) ⇒ Object

  Deletes an existing property of type JSON.

• #service(path) ⇒ Service

  Locates the service corresponding to the given path.

Methods inherited from Service

#inspect, #to_s

Instance Method Details

#get(opts = {}) ⇒ UserOption

Returns a user profile property of type JSON.

Example request(for user with identifier 123 and option with identifier 456):

GET /ovirt-engine/api/users/123/options/456

The result will be the following XML document:

  <user_option href="/ovirt-engine/api/users/123/options/456" id="456">
    <name>SomeName</name>
    <content>["any", "JSON"]</content>
    <user href="/ovirt-engine/api/users/123" id="123"/>
  </user_option>

Parameters:

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

• (UserOption)

# File 'lib/ovirtsdk4/services.rb', line 29644

def get(opts = {})
  internal_get(GET, opts)
end

#remove(opts = {}) ⇒ Object

Deletes an existing property of type JSON.

Example request(for user with identifier 123 and option with identifier 456):

DELETE /ovirt-engine/api/users/123/options/456

Parameters:

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

# File 'lib/ovirtsdk4/services.rb', line 29674

def remove(opts = {})
  internal_remove(REMOVE, 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.

Raises:

• (Error)

# File 'lib/ovirtsdk4/services.rb', line 29685

def service(path)
  if path.nil? || path == ''
    return self
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end