All Downloads are FREE. Search and download functionalities are using the official Maven repository.

services.AffinityGroupVmsService Maven / Gradle / Ivy

There is a newer version: 4.6.0
Show newest version
/*
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 org.ovirt.api.metamodel.annotations.In;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;
import types.Vm;

/**
 * This service manages a collection of all virtual machines assigned to an affinity group.
 *
 * @author Martin Sivak 
 * @date 14 Sep 2016
 * @status added
 */
@Service
@Area("SLA")
public interface AffinityGroupVmsService {
    /**
     * Add a virtual machine to the affinity group.
     *
     * For example to add the virtual machine 000-000 to affinity group 123-456 send a request to:
     *
     * [source]
     * ----
     * POST /ovirt-engine/api/clusters/000-000/affinitygroups/123-456/vms
     * ----
     *
     * With the following body:
     *
     * [source,xml]
     * ----
     * 
     * ----
     *
     * @author Martin Sivak 
     * @date 14 Sep 2016
     * @status added
     */
    interface Add {
        @In @Out Vm vm();
    }

    /**
     * List all virtual machines assigned to this affinity group.
     *
     * @author Martin Sivak 
     * @date 14 Sep 2016
     * @status added
     */
    interface List {
        @Out Vm[] vms();

        /**
         * Sets the maximum number of virtual machines to return. If not specified all the virtual machines are
         * returned.
         */
        @In Integer max();
    }

    /**
     * Access the service that manages the virtual machine assignment to this affinity group.
     *
     * @author Martin Sivak 
     * @date 14 Sep 2016
     * @status added
     */
    @Service AffinityGroupVmService vm(String id);
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy