Class: OvirtSDK4::TagsService
- Defined in:
- lib/ovirtsdk4/services.rb,
lib/ovirtsdk4/services.rb
Instance Method Summary collapse
-
#add(tag, opts = {}) ⇒ Tag
Add a new tag to the system.
-
#list(opts = {}) ⇒ Array<Tag>
List the tags in the system.
-
#service(path) ⇒ Service
Locates the service corresponding to the given path.
-
#tag_service(id) ⇒ TagService
Reference to the service that manages a specific tag.
Methods inherited from Service
Instance Method Details
#add(tag, opts = {}) ⇒ Tag
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:
<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:
<tag>
<name>mytag</name>
<parent>
<name>myparenttag</name>
</parent>
</tag>
25528 25529 25530 |
# File 'lib/ovirtsdk4/services.rb', line 25528 def add(tag, opts = {}) internal_add(tag, Tag, ADD, opts) end |
#list(opts = {}) ⇒ Array<Tag>
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
<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)
The order of the returned list of tags isn’t guaranteed.
25595 25596 25597 |
# File 'lib/ovirtsdk4/services.rb', line 25595 def list(opts = {}) internal_get(LIST, opts) end |
#service(path) ⇒ Service
Locates the service corresponding to the given path.
25617 25618 25619 25620 25621 25622 25623 25624 25625 25626 |
# File 'lib/ovirtsdk4/services.rb', line 25617 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) ⇒ TagService
Reference to the service that manages a specific tag.
25606 25607 25608 |
# File 'lib/ovirtsdk4/services.rb', line 25606 def tag_service(id) TagService.new(self, id) end |