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 3187 def initialize(connection, path) @connection = connection @path = path end
Assign tag to specific entity in the system.
For example to assign tag `mytag` to virtual machine with the id `123` send a request like this:
.… POST /ovirt-engine/api/vms/123/tags .…
With a request body like this:
<tag>
<name>mytag</name>
</tag>
@param tag [Tag] The assigned tag.
@param opts [Hash] Additional options.
@return [Tag]
# File lib/ovirtsdk4/services.rb, line 3216 def add(tag, opts = {}) if tag.is_a?(Hash) tag = OvirtSDK4::Tag.new(tag) end query = {} request = HttpRequest.new(method: :POST, url: @path, query: query) begin writer = XmlWriter.new(nil, true) TagWriter.write_one(tag, 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 TagReader.read_one(reader) ensure reader.close end else check_fault(response) end end
List all tags assigned to the specific entity.
For example to list all the tags of the virtual machine with id `123` send a request like this:
.… GET /ovirt-engine/api/vms/123/tags .…
<tags>
<tag href="/ovirt-engine/api/tags/222" id="222"> <name>mytag</name> <description>mytag</description> <vm href="/ovirt-engine/api/vms/123" id="123"/> </tag>
</tags>
@param opts [Hash] Additional options.
@option opts [Integer] :max Sets the maximum number of tags to return. If not specified all the tags are returned.
@return [Array<Tag>]
# File lib/ovirtsdk4/services.rb, line 3269 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 TagReader.read_many(reader) ensure reader.close end else 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 3309 def service(path) if path.nil? || path == '' return self end index = path.index('/') if index.nil? return tag_service(path) end return tag_service(path[0..(index - 1)]).service(path[(index +1)..-1]) end
Reference to the service that manages assignment of specific tag.
@param id [String] The identifier of the `tag`.
@return [AssignedTagService] A reference to the `tag` service.
# File lib/ovirtsdk4/services.rb, line 3298 def tag_service(id) AssignedTagService.new(@connection, "#{@path}/#{id}") end
Returns an string representation of this service.
@return [String]
# File lib/ovirtsdk4/services.rb, line 3325 def to_s "#<#{AssignedTagsService}:#{@path}>" end