services.IscsiBondService 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.Out;
import org.ovirt.api.metamodel.annotations.Service;
import types.IscsiBond;

@Service
@Area("Storage")
public interface IscsiBondService {
    interface Get extends Follow {

        /**
         * The iSCSI bond.
         *
         * @author Idan Shaby 
         * @author Billy Burmester 
         * @date 11 May 2018
         * @status updated_by_docs
         */
        @Out IscsiBond bond();
    }

    /**
     * Updates an iSCSI bond.
     *
     * Updating of an iSCSI bond can be done on the `name` and the `description` attributes only. For example, to
     * update the iSCSI bond `456` of data center `123`, send a request like this:
     *
     * [source]
     * ----
     * PUT /ovirt-engine/api/datacenters/123/iscsibonds/1234
     * ----
     *
     * The request body should look like this:
     *
     * [source,xml]
     * ----
     * 
     *    mybond
     *    My iSCSI bond
     * 
     * ----
     *
     * @author Maor Lipchuk 
     * @date 14 Sep 2016
     * @status added
     */
    interface Update {

        /**
         * The iSCSI bond to update.
         *
         * @author Idan Shaby 
         * @author Billy Burmester 
         * @date 11 May 2018
         * @status updated_by_docs
         */
        @In @Out IscsiBond bond();

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

    /**
     * Removes of an existing iSCSI bond.
     *
     * For example, to remove the iSCSI bond `456` send a request like this:
     *
     * [source]
     * ----
     * DELETE /ovirt-engine/api/datacenters/123/iscsibonds/456
     * ----
     *
     * @author Maor Lipchuk 
     * @author Billy Burmester 
     * @date 11 May 2018
     * @status updated_by_docs
     */
    interface Remove {
        /**
         * Indicates if the remove should be performed asynchronously.
         */
        @In Boolean async();
    }

    @Service NetworksService networks();
    @Service StorageServerConnectionsService storageServerConnections();
}