class OvirtSDK4::BookmarksService

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

Public Instance Methods

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

Adding a new bookmark.

Example of adding a bookmark:

source

POST /ovirt-engine/api/bookmarks


source,xml

<bookmark>

<name>new_example_vm</name>
<value>vm: name=new_example*</value>

</bookmark>


@param bookmark [Bookmark] The added bookmark.

@param opts [Hash] Additional options.

@return [Bookmark]

# File lib/ovirtsdk4/services.rb, line 4288
def add(bookmark, opts = {})
  if bookmark.is_a?(Hash)
    bookmark = OvirtSDK4::Bookmark.new(bookmark)
  end
  query = {}
  request = HttpRequest.new(method: :POST, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    BookmarkWriter.write_one(bookmark, 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 BookmarkReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
bookmark_service(id) click to toggle source

A reference to the service managing a specific bookmark.

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

@return [BookmarkService] A reference to the `bookmark` service.

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

Listing all the available bookmarks.

Example of listing bookmarks:

source

GET /ovirt-engine/api/bookmarks


source,xml

<bookmarks>

<bookmark href="/ovirt-engine/api/bookmarks/123" id="123">
  <name>database</name>
  <value>vm: name=database*</value>
</bookmark>
<bookmark href="/ovirt-engine/api/bookmarks/456" id="456">
  <name>example</name>
  <value>vm: name=example*</value>
</bookmark>

</bookmarks>


@param opts [Hash] Additional options.

@option opts [Integer] :max Sets the maximum number of bookmarks to return. If not specified all the bookmarks are returned.

@return [Array<Bookmark>]

# File lib/ovirtsdk4/services.rb, line 4345
def list(opts = {})
  query = {}
  value = opts[:max]
  unless value.nil?
    value = Writer.render_integer(value)
    query['max'] = 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 BookmarkReader.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 4385
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return bookmark_service(path)
  end
  return bookmark_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 4401
def to_s
  "#<#{BookmarksService}:#{@path}>"
end