services.VmMediatedDeviceService 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) 2022 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.VmMediatedDevice;

@Service
@Area("Virtualization")
public interface VmMediatedDeviceService {

    /**
     * Retrieves the configuration of mediated devices in the virtual machine.
     *
     * @author Milan Zamazal 
     * @date 10 March 2022
     * @status added
     * @since 4.5
     */
    interface Get extends Follow {
        /**
         * The information about the mediated device of the virtual machine.
         *
         * @author Milan Zamazal 
         * @date 10 Mar 2022
         * @status added
         * @since 4.5
         */
        @Out VmMediatedDevice device();
    }

    /**
     * Updates the information about the mediated device.
     *
     * You can update the information using `specParams` element.
     *
     * For example, to update a mediated device, send a request like this:
     *
     * [source]
     * ----
     * PUT /ovirt-engine/api/vms/123/mediateddevices/00000000-0000-0000-0000-000000000000
     * 
     *   
     *     
     *       mdevType
     *       nvidia-11
     *     
     *   
     * 
     * ----
     *
     * with response body:
     *
     * [source,xml]
     * ----
     * 
     *   
     *   
     *     
     *       mdevType
     *       nvidia-11
     *     
     *   
     * 
     * ----
     *
     * @author Milan Zamazal 
     * @date 10 Mar 2022
     * @status added
     * @since 4.5
     */
    interface Update {
        /**
         * The information about the mediated device.
         *
         * The request data must contain `specParams` properties.
         * The response data contains complete information about the
         * updated mediated device.
         *
         * @author Milan Zamazal 
         * @date 10 Mar 2022
         * @status added
         * @since 4.5
         */
        @In @Out VmMediatedDevice device();

        /**
         * Indicates if the update should be performed asynchronously.
         *
         * @author Milan Zamazal 
         * @date 10 Mar 2022
         * @status added
         * @since 4.5
         */
        @In Boolean async();
    }

    /**
     * Remove the mediated device from the virtual machine.
     *
     * @author Milan Zamazal 
     * @date 10 March 2022
     * @status added
     * @since 4.5
     */
    interface Remove {
        /**
         * Indicates if the remove should be performed asynchronously.
         *
         * @author Milan Zamazal 
         * @date 10 Mar 2022
         * @status added
         * @since 4.5
         */
        @In Boolean async();
    }
}