class OvirtSDK4::BookmarksService
Constants
- ADD
- LIST
Public Instance Methods
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.
@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 [Bookmark]
# File lib/ovirtsdk4/services.rb, line 4516 def add(bookmark, opts = {}) internal_add(bookmark, Bookmark, ADD, opts) end
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 4582 def bookmark_service(id) BookmarkService.new(self, id) end
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>
The order of the returned bookmarks isn't guaranteed.
@param opts [Hash] Additional options.
@option opts [String] :follow Indicates which inner links should be followed. The objects referenced by these links will be fetched as part
of the current request. See <<documents/003_common_concepts/follow, here>> for details.
@option opts [Integer] :max Sets the maximum number of bookmarks to return. If not specified all the bookmarks are returned.
@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 [Array<Bookmark>]
# File lib/ovirtsdk4/services.rb, line 4571 def list(opts = {}) internal_get(LIST, opts) 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 4593 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