class OvirtSDK4::TagsService

Public Class Methods

new(connection, path) click to toggle source

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 25882
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

add(tag, opts = {}) click to toggle source

Add a new tag to the system.

For example, to add new tag with name `mytag` to the system send a request like this:

.… POST /ovirt-engine/api/tags .…

With a request body like this:

source,xml

<tag>

<name>mytag</name>

</tag>


NOTE: The root tag is a special pseudo-tag assumed as the default parent tag if no parent tag is specified. The root tag cannot be deleted nor assigned a parent tag.

To create new tag with specific parent tag send a request body like this:

source,xml

<tag>

<name>mytag</name>
<parent>
  <name>myparenttag</name>
</parent>

</tag>


@param tag [Tag] The added tag.

@param opts [Hash] Additional options.

@return [Tag]

# File lib/ovirtsdk4/services.rb, line 25926
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(opts = {}) click to toggle source

List the tags in the system.

For example to list the full hierarchy of the tags in the system send a request like this:

.… GET /ovirt-engine/api/tags .…

source,xml

<tags>

<tag href="/ovirt-engine/api/tags/222" id="222">
  <name>root2</name>
  <description>root2</description>
  <parent href="/ovirt-engine/api/tags/111" id="111"/>
</tag>
<tag href="/ovirt-engine/api/tags/333" id="333">
  <name>root3</name>
  <description>root3</description>
  <parent href="/ovirt-engine/api/tags/222" id="222"/>
</tag>
<tag href="/ovirt-engine/api/tags/111" id="111">
  <name>root</name>
  <description>root</description>
</tag>

</tags>


In the previous XML output you can see the following hierarchy of the tags: .… root: (id: 111)

- root2    (id: 222)
  - root3  (id: 333)

.…

@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 25995
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
service(path) click to toggle source

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 26035
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
tag_service(id) click to toggle source

Reference to the service that manages a specific tag.

@param id [String] The identifier of the `tag`.

@return [TagService] A reference to the `tag` service.

# File lib/ovirtsdk4/services.rb, line 26024
def tag_service(id)
  TagService.new(@connection, "#{@path}/#{id}")
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 26051
def to_s
  "#<#{TagsService}:#{@path}>"
end