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 25707 def initialize(connection, path) @connection = connection @path = path end
Gets the information about the tag.
For example to retrieve the information about the tag with the id `123` send a request like this:
.… GET /ovirt-engine/api/tags/123 .…
<tag href=“/ovirt-engine/api/tags/123” id=“123”>
<name>root</name> <description>root</description>
</tag>
@param opts [Hash] Additional options.
@return [Tag]
# File lib/ovirtsdk4/services.rb, line 25733 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 TagReader.read_one(reader) ensure reader.close end else check_fault(response) end end
Removes the tag from the system.
For example to remove the tag with id `123` send a request like this:
.… DELETE /ovirt-engine/api/tags/123 .…
@param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the remove should be performed asynchronously.
# File lib/ovirtsdk4/services.rb, line 25762 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 25853 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 25865 def to_s "#<#{TagService}:#{@path}>" end
Updates the tag entity.
For example to update parent tag to tag with id `456` of the tag with id `123` send a request like this:
.… PUT /ovirt-engine/api/tags/123 .…
With request body like:
<tag>
<parent id="456"/>
</tag>
You may also specify a tag name instead of id. For example to update parent tag to tag with name `mytag` of the tag with id `123` send a request like this:
<tag>
<parent> <name>mytag</name> </parent>
</tag>
@param tag [Tag] The updated tag. @param opts [Hash] Additional options.
@option opts [Boolean] :async Indicates if the update should be performed asynchronously.
@return [Tag]
# File lib/ovirtsdk4/services.rb, line 25813 def update(tag, opts = {}) if tag.is_a?(Hash) tag = OvirtSDK4::Tag.new(tag) 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) TagWriter.write_one(tag, 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 TagReader.read_one(reader) ensure reader.close end return result else check_fault(response) end end