services.ClusterService 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-2016 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 org.ovirt.api.metamodel.annotations.In;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;
import services.gluster.GlusterHooksService;
import services.gluster.GlusterVolumesService;
import types.Cluster;

 /**
  * A service to manage specific cluster.
  *
  * @author Yaniv Bronheim 
  * @date 12 Dec 2016
  * @status added
  */
@Service
@Area("Virtualization")
public interface ClusterService {
    /**
     * Get information about the cluster.
     *
     * An example of getting a cluster:
     *
     * [source]
     * ----
     * GET /ovirt-engine/api/clusters/123
     * ----
     *
     * [source,xml]
     * ----
     * 
     *   
     *     
     *   
     *   Default
     *   The default server cluster
     *   
     *   
     *   
     *   
     *   
     *   
     *   false
     *   
     *     x86_64
     *     Intel Penryn Family
     *   
     *   
     *     migrate
     *   
     *   
     *     true
     *     
     *       false
     *       50
     *     
     *     
     *       false
     *     
     *   
     *   false
     *   false
     *   
     *     true
     *     true
     *   
     *   false
     *   
     *     
     *       100
     *     
     *     
     *       true
     *     
     *   
     *   
     *     inherit
     *     
     *       auto
     *     
     *     inherit
     *   
     *   false
     *   
     *     random
     *   
     *   
     *   false
     *   false
     *   false
     *   
     *     4
     *     0
     *   
     *   true
     *   
     * 
     * ----
     *
     * @author Yaniv Bronhaim 
     * @date 12 Dec 2016
     * @status added
     */
    interface Get {
        @Out Cluster cluster();

        /**
         * Indicates if the results should be filtered according to the permissions of the user.
         */
        @In Boolean filter();
    }

    /**
     * Updates information about the cluster.
     *
     * Only specified fields are updated, others remain unchanged.
     *
     * E.g. update cluster's CPU:
     *
     * [source]
     * ----
     * PUT /ovirt-engine/api/clusters/123
     * ----
     *
     * With request body like:
     *
     * [source,xml]
     * ----
     * 
     *   
     *     Intel Haswell-noTSX Family
     *   
     * 
     * ----
     *
     * @author Jakub Niedermertl 
     * @date 14 Sep 2016
     * @status added
     */
    interface Update {
        @In @Out Cluster cluster();

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

    /**
     * Removes cluster from the system.
     *
     * [source]
     * ----
     * DELETE /ovirt-engine/api/clusters/00000000-0000-0000-0000-000000000000
     * ----
     *
     * @author Jakub Niedermertl 
     * @date 14 Sep 2016
     * @status added
     */
    interface Remove {
        /**
         * Indicates if the remove should be performed asynchronously.
         */
        @In Boolean async();
    }

    interface ResetEmulatedMachine {
        /**
         * Indicates if the reset should be performed asynchronously.
         */
        @In Boolean async();
    }

    /**
     * Reference to the service that manages affinity groups.
     *
     * @author Yaniv Bronheim 
     * @date 12 Dec 2016
     * @status added
     */
    @Service AffinityGroupsService affinityGroups();

    /**
     * Reference to the service that manages assigned CPU profiles for cluster.
     *
     * @author Yaniv Bronheim 
     * @date 12 Dec 2016
     * @status added
     */
    @Service AssignedCpuProfilesService cpuProfiles();

    /**
     * Reference to the service that manages assigned networks for cluster.
     *
     * @author Yaniv Bronheim 
     * @date 12 Dec 2016
     * @status added
     */
    @Service AssignedNetworksService networks();

    /**
     * Reference to permissions.
     *
     * @author Yaniv Bronheim 
     * @date 12 Dec 2016
     * @status added
     */
    @Service AssignedPermissionsService permissions();

    /**
     * Reference to the service that manages the Gluster hooks for cluster.
     *
     * @author Yaniv Bronheim 
     * @date 12 Dec 2016
     * @status added
     */
    @Service GlusterHooksService glusterHooks();

    /**
     * Reference to the service that manages Gluster volumes for cluster.
     *
     * @author Yaniv Bronheim 
     * @date 12 Dec 2016
     * @status added
     */
    @Service GlusterVolumesService glusterVolumes();

    /**
     * A sub collection with all the supported network filters for this cluster.
     */
    @Service NetworkFiltersService networkFilters();

}