Class: OvirtSDK4::UserOptionService

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

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


29209
29210
29211
# File 'lib/ovirtsdk4/services.rb', line 29209

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.


29239
29240
29241
# File 'lib/ovirtsdk4/services.rb', line 29239

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:


29304
29305
29306
29307
29308
29309
# File 'lib/ovirtsdk4/services.rb', line 29304

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

#update(option, opts = {}) ⇒ UserOption

Replaces an existing property of type JSON with a new one.

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

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

Payload:

<user_option>
  <name>SomeName</name>
  <content>{"new" : "JSON"}</content>
</user_option>

The result will be the following XML document:

<user_option href="/ovirt-engine/api/users/123/options/789" id="789">
  <name>SomeName</name>
  <content>{"new" : "JSON"}</content>
  <user href="/ovirt-engine/api/users/123" id="123"/>
</user_option>

Parameters:

  • option (UserOption)

    The option to update.

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


29293
29294
29295
# File 'lib/ovirtsdk4/services.rb', line 29293

def update(option, opts = {})
  internal_update(option, UserOption, UPDATE, opts)
end