services.DiskAttachmentsService 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) 2016 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 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.DiskAttachment;

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


/**
 * This service manages the set of disks attached to a virtual machine. Each attached disk is represented by a
 * <>, containing the bootable flag, the disk interface and the reference to
 * the disk.
 */
@Service
public interface DiskAttachmentsService {
    /**
     * Adds a new disk attachment to the virtual machine. The `attachment` parameter can contain just a reference, if
     * the disk already exists:
     *
     * [source,xml]
     * ----
     * 
     *   true
     *   true
     *   ide
     *   true
     *   
     * 
     * ----
     *
     * Or it can contain the complete representation of the disk, if the disk doesn't exist yet:
     *
     * [source,xml]
     * ----
     * 
     *   true
     *   true
     *   ide
     *   true
     *   
     *     mydisk
     *     1024
     *     ...
     *   
     * 
     * ----
     *
     * In this case the disk will be created and then attached to the virtual machine.
     *
     * In both cases, use the following URL for a virtual machine with an id `345`:
     *
     * [source]
     * ----
     * POST /ovirt-engine/api/vms/345/diskattachments
     * ----
     *
     * IMPORTANT: The server accepts requests that don't contain the `active` attribute, but the effect is
     * undefined. In some cases the disk will be automatically activated and in other cases it won't. To
     * avoid issues it is strongly recommended to always include the `active` attribute with the desired
     * value.
     *
     * @author Idan Shaby 
     * @date 15 Sep 2016
     * @status added
     */
    interface Add {
        interface Signature1 extends Add {
            @InputDetail
            default void inputDetail() {
                mandatory(attachment().bootable());
                mandatory(attachment()._interface());
                mandatory(attachment().passDiscard());
            }
        }

        interface ProvidingDiskId extends Add {
            @InputDetail
            default void inputDetail() {
                mandatory(attachment().disk().id());
            }
        }

        /**
         * The disk attachment to add to the virtual machine.
         *
         * @author Idan Shaby 
         * @author Billy Burmester 
         * @date 11 May 2018
         * @status updated_by_docs
         */
        @In @Out DiskAttachment attachment();
    }

    /**
     * List the disk that are attached to the virtual machine.
     *
     * The order of the returned list of disks attachments isn't guaranteed.
     *
     * @author Juan Hernandez 
     * @author Billy Burmester 
     * @date 11 May 2018
     * @status updated_by_docs
     */
    interface List extends Follow {

        /**
         * A list of disk attachments that are attached to the virtual machine.
         *
         * @author Idan Shaby 
         * @author Billy Burmester 
         * @date 11 May 2018
         * @status updated_by_docs
         */
        @Out DiskAttachment[] attachments();
    }

    /**
     * Reference to the service that manages a specific attachment.
     */
    @Service DiskAttachmentService attachment(String id);
}