services.ImageService Maven / Gradle / Ivy

Go to download
/*
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 org.ovirt.api.metamodel.annotations.In;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;
import types.Cluster;
import types.Disk;
import types.Image;
import types.StorageDomain;
import types.Template;

@Service
@Area("Storage")
public interface ImageService {
    interface Get {
        @Out Image image();
    }

    interface Import {

        /**
         * Cluster where the image should be imported. Has effect only in case `import_as_template` parameter
         * is set to `true`.
         *
         * @author Ondra Machacek 
         * @date 11 Oct 2016
         * @status added
         */
        @In Cluster cluster();

        /**
         * The disk which should be imported.
         *
         * @author Ondra Machacek 
         * @date 11 Oct 2016
         * @status added
         */
        @In Disk disk();

        /**
         * Specify if template should be created from the imported disk.
         *
         * @author Ondra Machacek 
         * @date 11 Oct 2016
         * @status added
         */
        @In Boolean importAsTemplate();

        /**
         * Name of the template, which should be created. Has effect only in case `import_as_template` parameter
         * is set to `true`.
         *
         * @author Ondra Machacek 
         * @date 11 Oct 2016
         * @status added
         */
        @In Template template();

        /**
         * Storage domain where disk should be imported.
         *
         * @author Ondra Machacek 
         * @date 11 Oct 2016
         * @status added
         */
        @In StorageDomain storageDomain();

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