services.DataCenterService 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 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 types.DataCenter;

/**
 * A service to manage a data center.
 *
 * @author Oved Ourfali 
 * @date 12 Dec 2016
 * @status added
 */
@Service
@Area("Virtualization")
public interface DataCenterService {

    /**
     * Get a data center.
     *
     * An example of getting a data center:
     *
     * [source]
     * ----
     * GET /ovirt-engine/api/datacenters/123
     * ----
     *
     * [source,xml]
     * ----
     * 
     *   Default
     *   The default Data Center
     *   
     *   
     *   
     *   
     *   
     *   
     *   
     *   false
     *   disabled
     *   up
     *   v3
     *   
     *     
     *       4
     *       0
     *    
     *   
     *   
     *     4
     *     0
     *   
     *   
     * 
     * ----
     *
     * @author Oved Ourfali 
     * @date 12 Dec 2016
     * @status added
     */
    interface Get {
        @Out DataCenter dataCenter();

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

    /**
     * Updates the data center.
     *
     * The `name`, `description`, `storage_type`, `version`, `storage_format` and `mac_pool` elements are updatable
     * post-creation. For example, to change the name and description of data center `123` send a request like this:
     *
     * [source]
     * ----
     * PUT /ovirt-engine/api/datacenters/123
     * ----
     *
     * With a request body like this:
     *
     * [source,xml]
     * ----
     * 
     *   myupdatedname
     *   An updated description for the data center
     * 
     * ----
     *
     * @author Shmuel Melamud 
     * @date 14 Sep 2016
     * @status added
     */
    interface Update {
        /**
         * The data center that is being updated.
         *
         * @author Shmuel Melamud 
         * @date 14 Sep 2016
         * @status added
         */
        @In @Out DataCenter dataCenter();

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

    /**
     * Removes the data center.
     *
     * [source]
     * ----
     * DELETE /ovirt-engine/api/datacenters/123
     * ----
     *
     * Without any special parameters, the storage domains attached to the data center are detached and then removed
     * from the storage. If something fails when performing this operation, for example if there is no host available to
     * remove the storage domains from the storage, the complete operation will fail.
     *
     * If the `force` parameter is `true` then the operation will always succeed, even if something fails while removing
     * one storage domain, for example. The failure is just ignored and the data center is removed from the database
     * anyway.
     *
     * @author Juan Hernandez 
     * @date 15 Aug 2016
     * @status added
     * @since 4.0.0
     */
    interface Remove {
        /**
         * Indicates if the operation should succeed, and the storage domain removed from the database, even if
         * something fails during the operation.
         *
         * This parameter is optional, and the default value is `false`.
         *
         * @author Juan Hernandez 
         * @date 15 Aug 2016
         * @status added
         * @since 4.0.4
         */
        @In Boolean force();

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

    /**
    * Attach and detach storage domains to and from a data center.
    *
    * For attaching a single storage domain we should use the following POST request:
    *
    * [source]
    * ----
    * POST /ovirt-engine/api/datacenters/123/storagedomains
    * ----
    *
    * With a request body like this:
    *
    * [source,xml]
    * ----
    * 
    *   data1
    * 
    * ----
    *
    * For detaching a single storage domain we should use the following DELETE request:
    *
    * [source]
    * ----
    * DELETE /ovirt-engine/api/datacenters/123/storagedomains/123
    * ----
    *
    * @author Maor Lipchuk 
    * @date 14 Sep 2016
    * @status added
    */
    @Service AttachedStorageDomainsService storageDomains();
    @Service ClustersService clusters();

    /**
     * Returns a reference to the service, that manages the networks, that are associated with the data center.
     *
     * @author Martin Mucha 
     * @date 24 Oct 2016
     * @status added
     */
    @Service DataCenterNetworksService networks();

    /**
     * Reference to the permissions service.
     *
     * @author Oved Ourfali 
     * @date 12 Dec 2016
     * @status added
     */
    @Service AssignedPermissionsService permissions();

    /**
     * Reference to the quotas service.
     *
     * @author Oved Ourfali 
     * @date 12 Dec 2016
     * @status added
     */
    @Service QuotasService quotas();

    /**
     * Reference to the QOSs service.
     *
     * @author Oved Ourfali 
     * @date 12 Dec 2016
     * @status added
     */
    @Service QossService qoss();

    /**
     * Reference to the iSCSI bonds service.
     *
     * @author Oved Ourfali 
     * @date 12 Dec 2016
     * @status added
     */
    @Service IscsiBondsService iscsiBonds();
}