org.ovirt.engine.sdk4.services.VmPoolService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation
There is a newer version: 4.5.1
/*
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 org.ovirt.engine.sdk4.Request;
import org.ovirt.engine.sdk4.Response;
import org.ovirt.engine.sdk4.Service;
import org.ovirt.engine.sdk4.builders.VmPoolBuilder;
import org.ovirt.engine.sdk4.types.VmPool;

/**
 * A service to manage a virtual machines pool.
 */
public interface VmPoolService extends Service {
    /**
     * 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]
     * ----
     * 
     * ----
     */
    public interface AllocateVmRequest extends Request {
        /**
         * Indicates if the allocation should be performed asynchronously.
         */
        AllocateVmRequest async(Boolean async);
    }
    
    /**
     * 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]
     * ----
     * 
     * ----
     */
    public interface AllocateVmResponse extends Response {
    }
    
    /**
     * 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]
     * ----
     * 
     * ----
     */
    AllocateVmRequest allocateVm();
    
    /**
     * 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
     *   
     *