class OvirtSDK4::GroupsService

Public Class Methods

new(connection, path) click to toggle source

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 10758
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

add(group, opts = {}) click to toggle source

Add group from a directory service. Please note that domain name is name of the authorization provider.

For example, to add the `Developers` group from the `internal-authz` authorization provider send a request like this:

source

POST /ovirt-engine/api/groups


With a request body like this:

source,xml

<group>

<name>Developers</name>
<domain>
  <name>internal-authz</name>
</domain>

</group>


@param group [Group] The `group` to add.

@param opts [Hash] Additional options.

@return [Group]

# File lib/ovirtsdk4/services.rb, line 10792
def add(group, opts = {})
  if group.is_a?(Hash)
    group = OvirtSDK4::Group.new(group)
  end
  query = {}
  request = HttpRequest.new(method: :POST, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    GroupWriter.write_one(group, writer)
    request.body = writer.string
  ensure
    writer.close
  end
  response = @connection.send(request)
  case response.code
  when 200, 201, 202
    begin
      reader = XmlReader.new(response.body)
      return GroupReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
group_service(id) click to toggle source

Locates the `group` service.

@param id [String] The identifier of the `group`.

@return [GroupService] A reference to the `group` service.

# File lib/ovirtsdk4/services.rb, line 10872
def group_service(id)
  GroupService.new(@connection, "#{@path}/#{id}")
end
list(opts = {}) click to toggle source

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 groups to return. If not specified all the groups are returned.

@option opts [String] :search A query string used to restrict the returned groups.

@return [Array<Group>]

# File lib/ovirtsdk4/services.rb, line 10834
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 GroupReader.read_many(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
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 10883
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return group_service(path)
  end
  return group_service(path[0..(index - 1)]).service(path[(index +1)..-1])
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 10899
def to_s
  "#<#{GroupsService}:#{@path}>"
end