class OvirtSDK4::TagService
Constants
- GET
- REMOVE
- UPDATE
Public Instance Methods
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 .…
- source,xml
<tag href=“/ovirt-engine/api/tags/123” id=“123”>
<name>root</name> <description>root</description>
</tag>
@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 [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 26805 def get(opts = {}) internal_get(GET, opts) 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. @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.
# File lib/ovirtsdk4/services.rb, line 26836 def remove(opts = {}) internal_remove(REMOVE, 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 26903 def service(path) if path.nil? || path == '' return self end raise Error.new("The path \"#{path}\" doesn't correspond to any service") 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:
- source,xml
<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:
- source,xml
<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.
@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 26892 def update(tag, opts = {}) internal_update(tag, Tag, UPDATE, opts) end