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 4092 def initialize(connection, path) @connection = connection @path = path end
Get a bookmark.
An example for getting a bookmark:
GET /ovirt-engine/api/bookmarks/123
<bookmark href=“/ovirt-engine/api/bookmarks/123” id=“123”>
<name>example_vm</name> <value>vm: name=example*</value>
</bookmark>
@param opts [Hash] Additional options.
@return [Bookmark]
# File lib/ovirtsdk4/services.rb, line 4119 def get(opts = {}) query = {} 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_one(reader) ensure reader.close end else check_fault(response) end end
Remove a bookmark.
An example for removing a bookmark:
DELETE /ovirt-engine/api/bookmarks/123
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the remove should be performed asynchronously.
# File lib/ovirtsdk4/services.rb, line 4149 def remove(opts = {}) query = {} value = opts[:async] unless value.nil? value = Writer.render_boolean(value) query['async'] = value end request = HttpRequest.new(method: :DELETE, url: @path, query: query) response = @connection.send(request) unless response.code == 200 check_fault(response) end 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 4230 def service(path) if path.nil? || path == '' return self end raise Error.new("The path \"#{path}\" doesn't correspond to any service") end
Returns an string representation of this service.
@return [String]
# File lib/ovirtsdk4/services.rb, line 4242 def to_s "#<#{BookmarkService}:#{@path}>" end
Update a bookmark.
An example for updating a bookmark:
PUT /ovirt-engine/api/bookmarks/123
With the request body:
<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.
@return [Bookmark]
# File lib/ovirtsdk4/services.rb, line 4190 def update(bookmark, opts = {}) if bookmark.is_a?(Hash) bookmark = OvirtSDK4::Bookmark.new(bookmark) end query = {} value = opts[:async] unless value.nil? value = Writer.render_boolean(value) query['async'] = value end request = HttpRequest.new(method: :PUT, 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 begin reader = XmlReader.new(response.body) return BookmarkReader.read_one(reader) ensure reader.close end return result else check_fault(response) end end