class OvirtSDK4::AssignedTagsService
Constants
- ADD
- LIST
Public Instance Methods
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:
- source,xml
<tag>
<name>mytag</name>
</tag>
@param tag [Tag] The assigned tag.
@param opts [Hash] Additional options.
@option opts [Hash] :headers ({}) Additional HTTP headers.
@option opts [Hash] :query ({}) Additional URL query parameters.
@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
given then the timeout set globally for the connection will be used.
@option opts [Boolean] :wait (true) If `true` wait for the response.
@return [Tag]
# File lib/ovirtsdk4/services.rb, line 3476 def add(tag, opts = {}) internal_add(tag, Tag, ADD, opts) 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 .…
- source,xml
<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>
The order of the returned tags isn't guaranteed.
@param opts [Hash] Additional options.
@option opts [String] :follow Indicates which inner links should be followed. The objects referenced by these links will be fetched as part
of the current request. See <<documents/003_common_concepts/follow, here>> for details.
@option opts [Integer] :max Sets the maximum number of tags to return. If not specified all the tags are returned.
@option opts [Hash] :headers ({}) Additional HTTP headers.
@option opts [Hash] :query ({}) Additional URL query parameters.
@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly
given then the timeout set globally for the connection will be used.
@option opts [Boolean] :wait (true) If `true` wait for the response.
@return [Array<Tag>]
# File lib/ovirtsdk4/services.rb, line 3527 def list(opts = {}) internal_get(LIST, opts) 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 3549 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 3538 def tag_service(id) AssignedTagService.new(self, id) end