class OvirtSDK4::UserOptionService

Constants

GET
REMOVE

Public Instance Methods

get(opts = {}) click to toggle source

Returns a user profile property of type JSON.

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

source

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


The result will be the following XML document:

source,xml

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

@param opts [Hash] Additional options.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (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.

@option opts [Boolean] :wait (true) If `true` wait for the response.

@return [UserOption]

# File lib/ovirtsdk4/services.rb, line 29644
def get(opts = {})
  internal_get(GET, opts)
end
remove(opts = {}) click to toggle source

Deletes an existing property of type JSON.

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

source

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


@param opts [Hash] Additional options.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (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.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 29674
def remove(opts = {})
  internal_remove(REMOVE, opts)
end
service(path) click to toggle source

Locates the service corresponding to the given path.

@param path [String] The path of the service.

@return [Service] A reference to the service.

# 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