class OvirtSDK4::UsersService
Public Class Methods
Creates a new implementation of the service.
@param connection [Connection] The connection to be used by this service.
@param path [String] The relative path of this service, for example `vms/123/disks`.
@api private
# File lib/ovirtsdk4/services.rb, line 24572 def initialize(connection, path) @connection = connection @path = path end
Public Instance Methods
Adds a new `user`.
@param user [User] The `user` to add.
@param opts [Hash] Additional options.
@return [User]
# File lib/ovirtsdk4/services.rb, line 24586 def add(user, opts = {}) if user.is_a?(Hash) user = OvirtSDK4::User.new(user) end query = {} request = HttpRequest.new(:method => :POST, :url => @path, :query => query) begin writer = XmlWriter.new(nil, true) UserWriter.write_one(user, writer) request.body = writer.string ensure writer.close end response = @connection.send(request) case response.code when 201, 202 begin reader = XmlReader.new(response.body) return UserReader.read_one(reader) ensure reader.close end else check_fault(response) end end
Returns the representation of the object managed by this service.
@param opts [Hash] Additional options.
@option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into
account. The default value is `true`, which means that case is taken into account. If you want to search ignoring case set it to `false`.
@option opts [Integer] :max Sets the maximum number of users to return. If not specified all the users are returned.
@option opts [String] :search A query string used to restrict the returned users.
@return [Array<User>]
# File lib/ovirtsdk4/services.rb, line 24628 def list(opts = {}) query = {} value = opts[:case_sensitive] unless value.nil? value = Writer.render_boolean(value) query['case_sensitive'] = value end value = opts[:max] unless value.nil? value = Writer.render_integer(value) query['max'] = value end value = opts[:search] unless value.nil? query['search'] = value end request = HttpRequest.new(:method => :GET, :url => @path, :query => query) response = @connection.send(request) case response.code when 200 begin reader = XmlReader.new(response.body) return UserReader.read_many(reader) ensure reader.close end else check_fault(response) end end
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 24677 def service(path) if path.nil? || path == '' return self end index = path.index('/') if index.nil? return user_service(path) end return user_service(path[0..(index - 1)]).service(path[(index +1)..-1]) end
Returns an string representation of this service.
@return [String]
# File lib/ovirtsdk4/services.rb, line 24693 def to_s return "#<#{UsersService}:#{@path}>" end
Locates the `user` service.
@param id [String] The identifier of the `user`.
@return [UserService] A reference to the `user` service.
# File lib/ovirtsdk4/services.rb, line 24666 def user_service(id) return UserService.new(@connection, "#{@path}/#{id}") end