org.ovirt.engine.sdk4.services.QosService Maven / Gradle / Ivy

/*
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 org.ovirt.engine.sdk4.services;

import java.io.IOException;
import org.ovirt.engine.sdk4.Request;
import org.ovirt.engine.sdk4.Response;
import org.ovirt.engine.sdk4.Service;
import org.ovirt.engine.sdk4.builders.QosBuilder;
import org.ovirt.engine.sdk4.types.Qos;

public interface QosService extends Service {
    /**
     * 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
     *   
     * 
     * ----
     */
    public interface GetRequest extends Request {
        /**
         * Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
         * of the current request. See <> for details.
         */
        GetRequest follow(String follow);
    }
    
    /**
     * 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
     *   
     * 
     * ----
     */
    public interface GetResponse extends Response {
        /**
         * Queried QoS object.
         */
        Qos qos();
    }
    
    /**
     * 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
     *   
     * 
     * ----
     */
    GetRequest get();
    
    /**
     * Remove specified QoS from datacenter.
     * 
     * [source]
     * ----
     * DELETE /ovirt-engine/api/datacenters/123/qoss/123
     * ----
     */
    public interface RemoveRequest extends Request {
        /**
         * Indicates if the remove should be performed asynchronously.
         */
        RemoveRequest async(Boolean async);
    }
    
    /**
     * Remove specified QoS from datacenter.
     * 
     * [source]
     * ----
     * DELETE /ovirt-engine/api/datacenters/123/qoss/123
     * ----
     */
    public interface RemoveResponse extends Response {
    }
    
    /**
     * Remove specified QoS from datacenter.
     * 
     * [source]
     * ----
     * DELETE /ovirt-engine/api/datacenters/123/qoss/123
     * ----
     */
    RemoveRequest remove();
    
    /**
     * 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
     *   
     * 
     * ----
     */
    public interface UpdateRequest extends Request {
        /**
         * Indicates if the update should be performed asynchronously.
         */
        UpdateRequest async(Boolean async);
        UpdateRequest qos(Qos qos);
        /**
         * Updated QoS object.
         */
        UpdateRequest qos(QosBuilder 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
     *   
     * 
     * ----
     */
    public interface UpdateResponse extends Response {
        /**
         * Updated QoS object.
         */
        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
     *   
     * 
     * ----
     */
    UpdateRequest update();
    
    /**
     * Service locator method, returns individual service on which the URI is dispatched.
     */
    Service service(String path);
}