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

Go to download
/*
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 java.util.List;
import org.ovirt.engine.sdk4.Request;
import org.ovirt.engine.sdk4.Response;
import org.ovirt.engine.sdk4.Service;
import org.ovirt.engine.sdk4.builders.ClusterFeatureBuilder;
import org.ovirt.engine.sdk4.types.ClusterFeature;

/**
 * Provides information about the additional features that are enabled for this cluster.
 * The features that are enabled are the available features for the cluster level
 */
public interface ClusterEnabledFeaturesService extends Service {
    /**
     * Enable an additional feature for a cluster.
     * 
     * For example, to enable a feature `456` on cluster `123`, send a request like this:
     * 
     * [source]
     * ----
     * POST /ovirt-engine/api/clusters/123/enabledfeatures
     * ----
     * 
     * The request body should look like this:
     * 
     * [source,xml]
     * ----
     * 
     * ----
     */
    public interface AddRequest extends Request {
        AddRequest feature(ClusterFeature feature);
        AddRequest feature(ClusterFeatureBuilder feature);
    }
    
    /**
     * Enable an additional feature for a cluster.
     * 
     * For example, to enable a feature `456` on cluster `123`, send a request like this:
     * 
     * [source]
     * ----
     * POST /ovirt-engine/api/clusters/123/enabledfeatures
     * ----
     * 
     * The request body should look like this:
     * 
     * [source,xml]
     * ----
     * 
     * ----
     */
    public interface AddResponse extends Response {
        ClusterFeature feature();
    }
    
    /**
     * Enable an additional feature for a cluster.
     * 
     * For example, to enable a feature `456` on cluster `123`, send a request like this:
     * 
     * [source]
     * ----
     * POST /ovirt-engine/api/clusters/123/enabledfeatures
     * ----
     * 
     * The request body should look like this:
     * 
     * [source,xml]
     * ----
     * 
     * ----
     */
    AddRequest add();
    
    /**
     * Lists the additional features enabled for the cluster.
     * 
     * For example, to get the features enabled for cluster `123` send a request like this:
     * 
     * [source]
     * ----
     * GET /ovirt-engine/api/clusters/123/enabledfeatures
     * ----
     * 
     * This will return a list of features:
     * 
     * [source,xml]
     * ----
     * 
     *   
     *      test_feature
     *   
     *   ...
     * 
     * ----
     */
    public interface ListRequest 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.
         */
        ListRequest follow(String follow);
    }
    
    /**
     * Lists the additional features enabled for the cluster.
     * 
     * For example, to get the features enabled for cluster `123` send a request like this:
     * 
     * [source]
     * ----
     * GET /ovirt-engine/api/clusters/123/enabledfeatures
     * ----
     * 
     * This will return a list of features:
     * 
     * [source,xml]
     * ----
     * 
     *   
     *      test_feature
     *   
     *   ...
     * 
     * ----
     */
    public interface ListResponse extends Response {
        /**
         * Retrieved features.
         */
        List features();
    }
    
    /**
     * Lists the additional features enabled for the cluster.
     * 
     * For example, to get the features enabled for cluster `123` send a request like this:
     * 
     * [source]
     * ----
     * GET /ovirt-engine/api/clusters/123/enabledfeatures
     * ----
     * 
     * This will return a list of features:
     * 
     * [source,xml]
     * ----
     * 
     *   
     *      test_feature
     *   
     *   ...
     * 
     * ----
     */
    ListRequest list();
    
    /**
     * A reference to the service that provides information about a specific
     * feature enabled for the cluster.
     */
    ClusterEnabledFeatureService featureService(String id);
    /**
     * Service locator method, returns individual service on which the URI is dispatched.
     */
    Service service(String path);
}