services.StorageServerConnectionsService 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.StorageConnection;

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

@Service
@Area("Storage")
public interface StorageServerConnectionsService {
    /**
     * Creates a new storage connection.
     *
     * For example, to create a new storage connection for the NFS server `mynfs.example.com` and NFS share
     * `/export/mydata` send a request like this:
     *
     * [source]
     * ----
     * POST /ovirt-engine/api/storageconnections
     * ----
     *
     * With a request body like this:
     *
     * [source,xml]
     * ----
     * 
     *   nfs
     *   mynfs.example.com
     *   /export/mydata
     *   
     *     myhost
     *   
     * 
     * ----
     *
     * @author Daniel Erez 
     * @date 14 Sep 2016
     * @status added
     */
    interface Add {
        @InputDetail
        default void inputDetail() {
            mandatory(connection().type());
        }

        /**
         * Add a iSCSI storage connection to the system.
         *
         * @author Ori Liel 
         * @date 18 Jan 2017
         * @status added
         */
        interface Iscsi extends Add {
            @InputDetail
            default void inputDetail() {
                mandatory(connection().address());
                mandatory(connection().port());
                mandatory(connection().target());
                optional(connection().password());
                optional(connection().username());
            }
        }

        /**
         * Add a nfs storage connection to the system.
         *
         * @author Ori Liel 
         * @date 18 Jan 2017
         * @status added
         */
        interface Nfs extends Add {
            @InputDetail
            default void inputDetail() {
                mandatory(connection().address());
                mandatory(connection().path());
                optional(connection().nfsRetrans());
                optional(connection().nfsTimeo());
                optional(connection().nfsVersion());
            }
        }

        /**
         * Add a vfs storage connection to the system.
         *
         * @author Ori Liel 
         * @date 18 Jan 2017
         * @status added
         */
        interface Vfs extends Add {
            @InputDetail
            default void inputDetail() {
                mandatory(connection().path());
                mandatory(connection().vfsType());
                optional(connection().address());
                optional(connection().mountOptions());
            }
        }

        /**
         * Add a Glusterfs storage connection to the system.
         *
         * @author Denis Chaplygin 
         * @author Byron Gravenorst 
         * @date 19 Jun 2018
         * @status updated_by_docs
         */
        interface Glusterfs extends Add {
            @InputDetail
            default void inputDetail() {
                mandatory(connection().path());
                mandatory(connection().vfsType());
                optional(connection().address());
                optional(connection().mountOptions());
                optional(connection().glusterVolume());
            }
        }

        /**
         * Add a local storage connection to the system.
         *
         * @author Ori Liel 
         * @date 18 Jan 2017
         * @status added
         */
        interface Local extends Add {
            @InputDetail
            default void inputDetail() {
                mandatory(connection().path());
            }
        }

        @In @Out StorageConnection connection();
    }

    /**
     * Returns the list of storage connections.
     *
     * The order of the returned list of connections isn't guaranteed.
     *
     * @author Juan Hernandez 
     * @date 15 Apr 2017
     * @status added
     */
    interface List extends Follow {
        @Out StorageConnection[] connections();

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

    @Service StorageServerConnectionService storageConnection(String id);
}