Class: OvirtSDK4::BookmarksService

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

#add(bookmark, opts = {}) ⇒ Bookmark

Adding a new bookmark.

Example of adding a bookmark:

POST /ovirt-engine/api/bookmarks
<bookmark>
  <name>new_example_vm</name>
  <value>vm: name=new_example*</value>
</bookmark>

Parameters:

  • bookmark (Bookmark)

    The added bookmark.

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


4480
4481
4482
# File 'lib/ovirtsdk4/services.rb', line 4480

def add(bookmark, opts = {})
  internal_add(bookmark, Bookmark, ADD, opts)
end

#bookmark_service(id) ⇒ BookmarkService

A reference to the service managing a specific bookmark.

Parameters:

  • id (String)

    The identifier of the bookmark.

Returns:


4546
4547
4548
# File 'lib/ovirtsdk4/services.rb', line 4546

def bookmark_service(id)
  BookmarkService.new(self, id)
end

#list(opts = {}) ⇒ Array<Bookmark>

Listing all the available bookmarks.

Example of listing bookmarks:

GET /ovirt-engine/api/bookmarks
<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>

The order of the returned bookmarks isn’t guaranteed.

Parameters:

  • opts (Hash) (defaults to: {})

    Additional options.

Options Hash (opts):

  • :follow (String)

    Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.

  • :max (Integer)

    Sets the maximum number of bookmarks to return. If not specified all the bookmarks are returned.

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


4535
4536
4537
# File 'lib/ovirtsdk4/services.rb', line 4535

def list(opts = {})
  internal_get(LIST, 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.


4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
# File 'lib/ovirtsdk4/services.rb', line 4557

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