services.QossService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of model Show documentation
Model management tools for the oVirt Engine API.
There is a newer version: 4.6.0
/*
Copyright (c) 2015 Red Hat, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package services;

import annotations.Area;
import mixins.Follow;
import org.ovirt.api.metamodel.annotations.In;
import org.ovirt.api.metamodel.annotations.InputDetail;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;
import types.Qos;

import static org.ovirt.api.metamodel.language.ApiLanguage.mandatory;
import static org.ovirt.api.metamodel.language.ApiLanguage.optional;

/**
 * Manages the set of _quality of service_ configurations available in a data center.
 *
 * @author Juan Hernandez 
 * @date 15 Apr 2017
 * @status added
 */
@Service
@Area("SLA")
public interface QossService {
    /**
     * Add a new QoS to the dataCenter.
     *
     * [source]
     * ----
     * POST /ovirt-engine/api/datacenters/123/qoss
     * ----
     *
     * The response will look as follows:
     *
     * [source,xml]
     * ----
     * 
     *   123
     *   123
     *   10
     *   storage
     *   
     * 
     * ----
     *
     * @author Ori Liel 
     * @author Aleksei Slaikovskii 
     * @date 26 Apr 2017
     * @status added
     */
    interface Add {
        @InputDetail
        default void inputDetail() {
            mandatory(qos().name());
            mandatory(qos().type());
            optional(qos().cpuLimit());
            optional(qos().description());
            optional(qos().inboundAverage());
            optional(qos().inboundBurst());
            optional(qos().inboundPeak());
            optional(qos().maxIops());
            optional(qos().maxReadIops());
            optional(qos().maxReadThroughput());
            optional(qos().maxThroughput());
            optional(qos().maxWriteIops());
            optional(qos().maxWriteThroughput());
            optional(qos().outboundAverage());
            optional(qos().outboundAverageLinkshare());
            optional(qos().outboundAverageRealtime());
            optional(qos().outboundAverageUpperlimit());
            optional(qos().outboundBurst());
            optional(qos().outboundPeak());
        }

        /**
         * Added QoS object.
         *
         * @author Aleksei Slaikovskii 
         * @date 24 Apr 2017
         * @status added
         */
        @In @Out Qos qos();
    }

    /**
     * Returns the list of _quality of service_ configurations available in the data center.
     *
     * [source]
     * ----
     * GET /ovirt-engine/api/datacenter/123/qoss
     * ----
     *
     * You will get response which will look like this:
     *
     * [source, xml]
     * ----
     * 
     *   ...
     *   ...
     *   ...
     * 
     * ----
     *
     * The returned list of quality of service configurations isn't guaranteed.
     *
     * @author Aleksei Slaikovskii 
     * @author Juan Hernandez 
     * @date 24 Apr 2017
     * @status added
     */
    interface List extends Follow {
        /**
         * List of queried QoS objects.
         *
         * @author Aleksei Slaikovskii 
         * @date 24 Apr 2017
         * @status added
         */
        @Out Qos[] qoss();

        /**
         * Sets the maximum number of QoS descriptors to return. If not specified all the descriptors are returned.
         */
        @In Integer max();
    }

    /**
     * A reference to a service managing a specific QoS.
     *
     * @author Aleksei Slaikovskii 
     * @date 25 Apr 2017
     * @status added
     */
    @Service QosService qos(String id);
}