services.QosService 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.optional;

@Service
@Area("SLA")
public interface QosService {
    /**
     * Get specified QoS in the data center.
     *
     * [source]
     * ----
     * GET /ovirt-engine/api/datacenters/123/qoss/123
     * ----
     *
     * You will get response like this one below:
     *
     * [source,xml]
     * ----
     * 
     *   123
     *   123
     *   1
     *   1
     *   storage
     *   
     * 
     * ----
     *
     * @author Aleksei Slaikovskii 
     * @date 24 Apr 2017
     * @status added
     */
    interface Get extends Follow {
        /**
         * Queried QoS object.
         *
         * @author Aleksei Slaikovskii 
         * @date 24 Apr 2017
         * @status added
         */
        @Out Qos qos();
    }

    /**
     * Update the specified QoS in the dataCenter.
     *
     * [source]
     * ----
     * PUT /ovirt-engine/api/datacenters/123/qoss/123
     * ----
     *
     * For example with curl:
     *
     * [source]
     * ----
     * curl -u admin@internal:123456 -X PUT -H "content-type: application/xml" -d \
     * "32132110" \
     * https://engine/ovirt-engine/api/datacenters/123/qoss/123
     * ----
     *
     * You will receive response like this:
     *
     * [source,xml]
     * ----
     * 
     *   321
     *   321
     *   10
     *   1
     *   storage
     *   
     * 
     * ----
     *
     * @author Ori Liel 
     * @author Aleksei Slaikovskii 
     * @date 26 Apr 2017
     * @status updated
     */
    interface Update {
        @InputDetail
        default void inputDetail() {
            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().name());
            optional(qos().outboundAverage());
            optional(qos().outboundAverageLinkshare());
            optional(qos().outboundAverageRealtime());
            optional(qos().outboundAverageUpperlimit());
            optional(qos().outboundBurst());
            optional(qos().outboundPeak());
        }

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

        /**
         * Indicates if the update should be performed asynchronously.
         */
        @In Boolean async();
    }

    /**
     * Remove specified QoS from datacenter.
     *
     * [source]
     * ----
     * DELETE /ovirt-engine/api/datacenters/123/qoss/123
     * ----
     *
     * @author Aleksei Slaikovskii 
     * @date 24 Apr 2017
     * @status added
     */
    interface Remove {
        /**
         * Indicates if the remove should be performed asynchronously.
         */
        @In Boolean async();
    }
}