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

import static org.ovirt.api.metamodel.language.ApiLanguage.mandatory;
import static org.ovirt.api.metamodel.language.ApiLanguage.optional;
/**
 * A service to manage data centers.
 *
 * @author Oved Ourfali 
 * @date 12 Dec 2016
 * @status added
 */
@Service
@Area("Virtualization")
public interface DataCentersService {

    /**
     * Creates a new data center.
     *
     * Creation of a new data center requires the `name` and `local` elements. For example, to create a data center
     * named `mydc` that uses shared storage (NFS, iSCSI or fibre channel) send a request like this:
     *
     * [source]
     * ----
     * POST /ovirt-engine/api/datacenters
     * ----
     *
     * With a request body like this:
     *
     * [source,xml]
     * ----
     * 
     *   mydc
     *   false
     * 
     * ----
     *
     * @author Shmuel Melamud 
     * @date 14 Sep 2016
     * @status added
     */
    interface Add {
        @InputDetail
        default void inputDetail() {
            mandatory(dataCenter().local());
            mandatory(dataCenter().name());
            optional(dataCenter().comment());
            optional(dataCenter().description());
            optional(dataCenter().macPool().id());
            optional(dataCenter().storageFormat());
            optional(dataCenter().version().major());
            optional(dataCenter().version().minor());
        }
        /**
         * The data center that is being added.
         *
         * @author Shmuel Melamud 
         * @date 14 Sep 2016
         * @status added
         */
        @In @Out DataCenter dataCenter();
    }

    /**
     * Lists the data centers.
     *
     * The following request retrieves a representation of the data centers:
     *
     * [source]
     * ----
     * GET /ovirt-engine/api/datacenters
     * ----
     *
     * The above request performed with `curl`:
     *
     * [source,bash]
     * ----
     * curl \
     * --request GET \
     * --cacert /etc/pki/ovirt-engine/ca.pem \
     * --header "Version: 4" \
     * --header "Accept: application/xml" \
     * --user "admin@internal:mypassword" \
     * https://myengine.example.com/ovirt-engine/api/datacenters
     * ----
     *
     * This is what an example response could look like:
     *
     * [source,xml]
     * ----
     * 
     *   Default
     *   The default Data Center
     *   
     *   
     *   
     *   
     *   
     *   
     *   
     *   false
     *   disabled
     *   up
     *   
     *     
     *       4
     *       0
     *     
     *   
     *   
     *     4
     *     0
     *   
     * 
     * ----
     *
     * Note the `id` code of your `Default` data center. This code identifies this data center in relation to other
     * resources of your virtual environment.
     *
     * The data center also contains a link to the storage domains collection. The data center uses this collection to
     * attach storage domains from the storage domains main collection.
     *
     * The order of the returned list of data centers is guaranteed only if the `sortby` clause is included in the
     * `search` parameter.
     *
     * @author Vinzenz Feenstra 
     * @date 14 Sep 2016
     * @status added
     */
    interface List extends Follow {
        @Out DataCenter[] dataCenters();

        /**
         * Sets the maximum number of data centers to return. If not specified all the data centers are returned.
         */
        @In Integer max();

        /**
         * A query string used to restrict the returned data centers.
         */
        @In String search();

        /**
         * Indicates if the search performed using the `search` parameter should be performed taking case into
         * account. The default value is `true`, which means that case is taken into account. If you want to search
         * ignoring case set it to `false`.
         */
        @In Boolean caseSensitive();

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

    /**
     * Reference to the service that manages a specific data center.
     *
     * @author Oved Ourfali 
     * @date 12 Dec 2016
     * @status added
     */
    @Service DataCenterService dataCenter(String id);
}