services.VmPoolService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of model Show documentation
Show all versions of model Show documentation
Model management tools for the oVirt Engine API.
/*
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 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.VmPool;
import static org.ovirt.api.metamodel.language.ApiLanguage.optional;
import static org.ovirt.api.metamodel.language.ApiLanguage.or;
/**
* A service to manage a virtual machines pool.
*
* @author Aleksei Slaikovskii
* @date 12 Dec 2016
* @status added
*/
@Service
@Area("Virtualization")
public interface VmPoolService {
/**
* This operation allocates a virtual machine in the virtual machine pool.
*
* [source]
* ----
* POST /ovirt-engine/api/vmpools/123/allocatevm
* ----
*
* The allocate virtual machine action does not take any action specific parameters, so the request body should
* contain an empty `action`:
*
* [source,xml]
* ----
*
* @date 14 Sep 2016
* @status added
*/
interface AllocateVm {
/**
* Indicates if the allocation should be performed asynchronously.
*/
@In Boolean async();
}
/**
* Get the virtual machine pool.
*
* [source]
* ----
* GET /ovirt-engine/api/vmpools/123
* ----
*
* You will get a XML response like that one:
* [source,xml]
* ----
*
* ...
* MyVmPool
* MyVmPool description
*
* 1
* 0
* 100
* false
* automatic
* false
* ...
* ...
*
* ----
*
* @author Aleksei Slaikovskii
* @date 12 Dec 2016
* @status added
*/
interface Get extends Follow {
/**
* Retrieved virtual machines pool.
*
* @author Aleksei Slaikovskii
* @date 12 Dec 2016
* @status added
*/
@Out VmPool pool();
/**
* Indicates if the results should be filtered according to the permissions of the user.
*/
@In Boolean filter();
}
/**
* Update the virtual machine pool.
*
* [source]
* ----
* PUT /ovirt-engine/api/vmpools/123
* ----
*
* The `name`, `description`, `size`, `prestarted_vms` and `max_user_vms`
* attributes can be updated after the virtual machine pool has been
* created.
*
* [source,xml]
* ----
*
* VM_Pool_B
* Virtual Machine Pool B
* 3
* 1
* 2
*
* ----
*
* @author Shmuel Melamud
* @date 14 Sep 2016
* @status added
*/
interface Update {
@InputDetail
default void inputDetail() {
optional(pool().comment());
optional(pool().description());
optional(pool().display().proxy());
optional(pool().maxUserVms());
optional(pool().name());
optional(pool().prestartedVms());
optional(pool().size());
optional(pool().type());
optional(pool().useLatestTemplateVersion());
or(optional(pool().cluster().id()), optional(pool().cluster().name()));
or(optional(pool().template().id()), optional(pool().template().name()));
}
/**
* The virtual machine pool that is being updated.
*
* @author Shmuel Melamud
* @date 14 Sep 2016
* @status added
*/
@In @Out VmPool pool();
/**
* Indicates if the update should be performed asynchronously.
*/
@In Boolean async();
}
/**
* Removes a virtual machine pool.
*
* [source]
* ----
* DELETE /ovirt-engine/api/vmpools/123
* ----
*
* @author Arik Hadas
* @date 14 Sep 2016
* @status added
*/
interface Remove {
/**
* Indicates if the remove should be performed asynchronously.
*/
@In Boolean async();
}
/**
* Reference to a service managing the virtual machine pool assigned permissions.
*
* @author Aleksei Slaikovskii
* @date 12 Dec 2016
* @status added
*/
@Service AssignedPermissionsService permissions();
}