org.ovirt.engine.sdk4.services.DiskAttachmentsService Maven / Gradle / Ivy
/*
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 org.ovirt.engine.sdk4.services;
import java.io.IOException;
import java.util.List;
import org.ovirt.engine.sdk4.Request;
import org.ovirt.engine.sdk4.Response;
import org.ovirt.engine.sdk4.Service;
import org.ovirt.engine.sdk4.builders.DiskAttachmentBuilder;
import org.ovirt.engine.sdk4.types.DiskAttachment;
/**
* 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.
*/
public interface DiskAttachmentsService extends Service {
/**
* 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.
*/
public interface AddRequest extends Request {
AddRequest attachment(DiskAttachment attachment);
AddRequest attachment(DiskAttachmentBuilder attachment);
}
/**
* 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.
*/
public interface AddResponse extends Response {
DiskAttachment attachment();
}
/**
* 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.
*/
AddRequest add();
/**
* List the disk that are attached to the virtual machine.
*/
public interface ListRequest extends Request {
}
/**
* List the disk that are attached to the virtual machine.
*/
public interface ListResponse extends Response {
List attachments();
}
/**
* List the disk that are attached to the virtual machine.
*/
ListRequest list();
/**
* Reference to the service that manages a specific attachment.
*/
DiskAttachmentService attachmentService(String id);
/**
* Service locator method, returns individual service on which the URI is dispatched.
*/
Service service(String path);
}