services.DiskAttachmentService 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.optional;

/**
 * This service manages the attachment of a disk to a virtual machine.
 */
@Service
public interface DiskAttachmentService {
    /**
     * Returns the details of the attachment, including the bootable flag and link to the disk.
     *
     * An example of getting a disk attachment:
     *
     * [source]
     * ----
     * GET /ovirt-engine/api/vms/123/diskattachments/456
     * ----
     *
     * [source,xml]
     * ----
     * 
     *   true
     *   true
     *   virtio
     *   
     *   
     * 
     * ----
     *
     * @author Boris Odnopozov 
     * @date 12 Dec 2016
     * @status added
     */
    interface Get extends Follow {
        @Out DiskAttachment attachment();
    }

    /**
     * Removes the disk attachment.
     *
     * This will only detach the disk from the virtual machine, but won't remove it from
     * the system, unless the `detach_only` parameter is `false`.
     *
     * An example of removing a disk attachment:
     *
     * [source]
     * ----
     * DELETE /ovirt-engine/api/vms/123/diskattachments/456?detach_only=true
     * ----
     *
     * @author Boris Odnopozov 
     * @date 12 Dec 2016
     * @status added
     */
    interface Remove {
        /**
         * Indicates if the disk should only be detached from the virtual machine, but not removed from the system.
         * The default value is `true`, which won't remove the disk from the system.
         */
        @In Boolean detachOnly();
    }

    /**
     * Update the disk attachment and the disk properties within it.
     *
     * [source]
     * ----
     * PUT /vms/{vm:id}/disksattachments/{attachment:id}
     * 
     *   true
     *   ide
     *   true
     *   
     *     mydisk
     *     1024
     *     ...
     *   
     * 
     * ----
     */
    interface Update {
        @InputDetail
        default void inputDetail() {
            optional(diskAttachment().disk().alias());
            optional(diskAttachment().bootable());
            optional(diskAttachment().description());
            optional(diskAttachment().disk().diskProfile().id());
            optional(diskAttachment().disk().format());
//            optional(diskAttachment()._interface()); //TODO: ucomment when able to handle '_'
            optional(diskAttachment().name());
            optional(diskAttachment().disk().propagateErrors());
            optional(diskAttachment().disk().provisionedSize());
            optional(diskAttachment().disk().quota().id());
            optional(diskAttachment().disk().readOnly());
            optional(diskAttachment().disk().sgio());
            optional(diskAttachment().disk().shareable());
//            optional(diskAttachment().size());
            optional(diskAttachment().disk().sparse());
            optional(diskAttachment().usesScsiReservation());
            optional(diskAttachment().disk().wipeAfterDelete());
        }
        @In @Out DiskAttachment diskAttachment();
    }
}