services.HostStorageService 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.HostStorage;

/**
 * A service to manage host storages.
 *
 * @author Aleksei Slaikovskii 
 * @date 12 Dec 2016
 * @status added
 */
@Service
@Area("Storage")
public interface HostStorageService {
    /**
     * Get list of storages.
     *
     * [source]
     * ----
     * GET /ovirt-engine/api/hosts/123/storage
     * ----
     *
     * The XML response you get will be like this one:
     *
     * [source,xml]
     * ----
     * 
     *   
     *     ...
     *   
     *   ...
     * 
     * ----
     *
     * The order of the returned list of storages isn't guaranteed.
     *
     * @author Aleksei Slaikovskii 
     * @date 12 Dec 2016
     * @status added
     */
    interface List extends Follow {
        /**
         * Retrieved list of storages.
         *
         * @author Aleksei Slaikovskii 
         * @date 12 Dec 2016
         * @status added
         */
        @Out HostStorage[] storages();

        /**
         * Indicates if the status of the LUNs in the storage should be checked.
         * Checking the status of the LUN is an heavy weight operation and
         * this data is not always needed by the user.
         * This parameter will give the option to not perform the status check of the LUNs.
         *
         * The default is `true` for backward compatibility.
         *
         * Here an example with the LUN status :
         *
         * [source,xml]
         * ----
         * 
         *   
         *     
         *       0
         *       1
         *       lun0
         *       123
         *       10737418240
         *       used
         *       LIO-ORG
         *       123
         *     
         *   
         *   iscsi
         *   
         * 
         * ----
         *
         * Here an example without the LUN status :
         *
         * [source,xml]
         * ----
         * 
         *   
         *     
         *       0
         *       1
         *       lun0
         *       123
         *       10737418240
         *       LIO-ORG
         *       123
         *     
         *   
         *   iscsi
         *   
         * 
         * ----
         */
        @In Boolean reportStatus();
    }

    /**
     * Reference to a service managing the storage.
     *
     * @author Aleksei Slaikovskii 
     * @date 12 Dec 2016
     * @status added
     */
    @Service StorageService storage(String id);
}