services.MacPoolService 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.optional;

@Service
@Area("Network")
public interface MacPoolService {
    interface Get extends Follow {
        @Out MacPool pool();
    }

    /**
     * Updates a MAC address pool.
     *
     * The `name`, `description`, `allow_duplicates`, and `ranges` attributes can be updated.
     *
     * For example, to update the MAC address pool of id `123` send a request like this:
     *
     * [source]
     * ----
     * PUT /ovirt-engine/api/macpools/123
     * ----
     *
     * With a request body like this:
     *
     * [source,xml]
     * ----
     * 
     *   UpdatedMACPool
     *   An updated MAC address pool
     *   false
     *   
     *     
     *       00:1A:4A:16:01:51
     *       00:1A:4A:16:01:e6
     *     
     *     
     *       02:1A:4A:01:00:00
     *       02:1A:4A:FF:FF:FF
     *     
     *   
     * 
     * ----
     *
     * @author Martin Mucha 
     * @date 14 Sep 2016
     * @status added
     */
    interface Update {
        @InputDetail
        default void inputDetail() {
            optional(pool().allowDuplicates());
            optional(pool().defaultPool());
            optional(pool().description());
            optional(pool().name());
            optional(pool().ranges()[COLLECTION].from());
            optional(pool().ranges()[COLLECTION].to());
        }
        @In @Out MacPool pool();

        /**
         * Indicates if the update should be performed asynchronously.
         */
        @In Boolean async();
    }

    /**
     * Removes a MAC address pool.
     *
     * For example, to remove the MAC address pool having id `123` send a request like this:
     *
     * [source]
     * ----
     * DELETE /ovirt-engine/api/macpools/123
     * ----
     *
     * @author Martin Mucha 
     * @date 14 Sep 2016
     * @status added
     */
    interface Remove {
        /**
         * Indicates if the remove should be performed asynchronously.
         */
        @In Boolean async();
    }

    /**
     * Returns a reference to the service that manages the permissions that are associated with the MacPool.
     *
     * @author Dominik Holler 
     * @date 22 September 2020
     * @since 4.4.3
     * @status added
     */
    @Service AssignedPermissionsService permissions();

}