class OvirtSDK4::BookmarkService
Constants
- GET
- REMOVE
- UPDATE
Public Instance Methods
Get a bookmark.
An example for getting a bookmark:
- source
GET
/ovirt-engine/api/bookmarks/123
- source,xml
<bookmark href=“/ovirt-engine/api/bookmarks/123” id=“123”>
<name>example_vm</name> <value>vm: name=example*</value>
</bookmark>
@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 [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 4378 def get(opts = {}) internal_get(GET, opts) end
Remove a bookmark.
An example for removing a bookmark:
- source
DELETE /ovirt-engine/api/bookmarks/123
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the remove should be performed asynchronously. @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.
# File lib/ovirtsdk4/services.rb, line 4410 def remove(opts = {}) internal_remove(REMOVE, 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 4467 def service(path) if path.nil? || path == '' return self end raise Error.new("The path \"#{path}\" doesn't correspond to any service") end
Update a bookmark.
An example for updating a bookmark:
- source
PUT /ovirt-engine/api/bookmarks/123
With the request body:
- source,xml
<bookmark>
<name>new_example_vm</name> <value>vm: name=new_example*</value>
</bookmark>
@param bookmark [Bookmark] The updated bookmark. @param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the update should be performed asynchronously.
@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 4456 def update(bookmark, opts = {}) internal_update(bookmark, Bookmark, UPDATE, opts) end