services.MacPoolsService 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) 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.MacPool;

import static org.ovirt.api.metamodel.language.ApiLanguage.COLLECTION;
import static org.ovirt.api.metamodel.language.ApiLanguage.mandatory;
import static org.ovirt.api.metamodel.language.ApiLanguage.optional;

@Service
@Area("Network")
public interface MacPoolsService {
    /**
     * Creates a new MAC address pool.
     *
     * Creation of a MAC address pool requires values for the `name` and `ranges` attributes.
     *
     * For example, to create MAC address pool send a request like this:
     *
     * [source]
     * ----
     * POST /ovirt-engine/api/macpools
     * ----
     *
     * With a request body like this:
     *
     * [source,xml]
     * ----
     * 
     *   MACPool
     *   A MAC address pool
     *   true
     *   false
     *   
     *     
     *       00:1A:4A:16:01:51
     *       00:1A:4A:16:01:e6
     *     
     *   
     * 
     * ----
     *
     * @author Martin Mucha 
     * @date 14 Sep 2016
     * @status added
     */
    interface Add {
        @InputDetail
        default void inputDetail() {
            mandatory(pool().name());
            mandatory(pool().ranges()[COLLECTION].from());
            mandatory(pool().ranges()[COLLECTION].to());
            optional(pool().allowDuplicates());
            optional(pool().defaultPool());
            optional(pool().description());
        }
        @In @Out MacPool pool();
    }

    /**
     * Return the list of MAC address pools of the system.
     *
     * The returned list of MAC address pools isn't guaranteed.
     *
     * @author Juan Hernandez 
     * @date 15 Arp 2017
     * @status added
     */
    interface List extends Follow {
        @Out MacPool[] pools();

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

    @Service MacPoolService macPool(String id);
}