services.IscsiBondsService 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.IscsiBond;

import static org.ovirt.api.metamodel.language.ApiLanguage.mandatory;

@Service
@Area("Storage")
public interface IscsiBondsService {

    /**
     * Create a new iSCSI bond on a data center.
     *
     * For example, to create a new iSCSI bond on data center `123` using storage connections `456` and `789`, send a
     * request like this:
     *
     * [source]
     * ----
     * POST /ovirt-engine/api/datacenters/123/iscsibonds
     * ----
     *
     * The request body should look like this:
     *
     * [source,xml]
     * ----
     * 
     *   mybond
     *   
     *     
     *     
     *   
     *   
     *     
     *   
     * 
     * ----
     *
     * @author Maor Lipchuk 
     * @date 14 Sep 2016
     * @status added
     */
    interface Add {
        @InputDetail
        default void inputDetail() {
            mandatory(bond().name());
        }
        @In @Out IscsiBond bond();
    }

    /**
     * Returns the list of iSCSI bonds configured in the data center.
     *
     * The order of the returned list of iSCSI bonds isn't guaranteed.
     *
     * @author Juan Hernandez 
     * @date 15 Apr 2017
     * @status added
     */
    interface List extends Follow {
        @Out IscsiBond[] bonds();

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

    @Service IscsiBondService iscsiBond(String id);
}