services.NetworkService 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.Network;

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

/**
 * A service managing a network
 *
 * @author Ori Ben Sasson 
 * @date 12 Dec 2016
 * @status added
 */
@Service
@Area("Network")
public interface NetworkService {
    /**
     * Gets a logical network.
     *
     * For example:
     *
     * [source]
     * ----
     * GET /ovirt-engine/api/networks/123
     * ----
     *
     * Will respond:
     *
     * [source,xml]
     * ----
     * 
     *   ovirtmgmt
     *   Default Management Network
     *   
     *   
     *   
     *   0
     *   false
     *   
     *     vm
     *   
     *   
     * 
     * ----
     *
     * @author Ori Ben Sasson 
     * @date 14 Sep 2016
     * @status added
     */
    interface Get extends Follow {
        @Out Network network();
    }

    /**
     * Updates a logical network.
     *
     * The `name`, `description`, `ip`, `vlan`, `stp` and `display` attributes can be updated.
     *
     * For example, to update the description of the logical network `123` send a request like this:
     *
     * [source]
     * ----
     * PUT /ovirt-engine/api/networks/123
     * ----
     *
     * With a request body like this:
     *
     * [source,xml]
     * ----
     * 
     *   My updated description
     * 
     * ----
     *
     *
     * The maximum transmission unit of a network is set using a PUT request to
     * specify the integer value of the `mtu` attribute.
     *
     * For example, to set the maximum transmission unit send a request like this:
     *
     * [source]
     * ----
     * PUT /ovirt-engine/api/datacenters/123/networks/456
     * ----
     *
     * With a request body like this:
     *
     * [source,xml]
     * ----
     * 
     *   1500
     * 
     * ----
     *
     * NOTE: Updating external networks is not propagated to the provider.
     *
     * @author Martin Mucha 
     * @author Dominik Holler 
     * @author Emma Heftman 
     * @date 17 Sep 2018
     * @status updated_by_docs
     */
    interface Update {
        @InputDetail
        default void inputDetail() {
            optional(network().comment());
            optional(network().description());
            optional(network().display());
            optional(network().ip().address());
            optional(network().ip().gateway());
            optional(network().ip().netmask());
            optional(network().mtu());
            optional(network().name());
            optional(network().stp());
            optional(network().vlan().id());
        }
        @In @Out Network network();

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

    /**
     * Removes a logical network, or the association of a logical network to a data center.
     *
     * For example, to remove the logical network `123` send a request like this:
     *
     * [source]
     * ----
     * DELETE /ovirt-engine/api/networks/123
     * ----
     *
     * Each network is bound exactly to one data center. So if we disassociate network with data center it has the same
     * result as if we would just remove that network. However it might be more specific to say we're removing network
     * `456` of data center `123`.
     *
     * For example, to remove the association of network `456` to data center `123` send a request like this:
     *
     * [source]
     * ----
     * DELETE /ovirt-engine/api/datacenters/123/networks/456
     * ----
     *
     * NOTE: To remove an external logical network, the network has to be removed directly from its provider by
     * https://developer.openstack.org/api-ref/network[OpenStack Networking API].
     * The entity representing the external network inside {product-name} is removed automatically,
     * if <> is enabled for the provider,
     * otherwise the entity has to be removed using this method.
     *
     * @author Martin Mucha 
     * @author Domininik Holler 
     * @author Emma Heftman 
     * @date 2 July 2018
     * @status updated-by-docs
     */
    interface Remove {
        /**
         * Indicates if the remove should be performed asynchronously.
         */
        @In Boolean async();
    }

    /**
     * Reference to the service that manages the permissions assigned to this network.
     *
     * @author Ori Ben Sasson 
     * @date 12 Dec 2016
     * @status added
     */
    @Service AssignedPermissionsService permissions();

    /**
     * Reference to the service that manages the vNIC profiles assigned to this network.
     *
     * @author Ori Ben Sasson 
     * @date 12 Dec 2016
     * @status added
     */
    @Service AssignedVnicProfilesService vnicProfiles();

    /**
     * Reference to the service that manages the network labels assigned to this network.
     *
     * @author Ori Ben Sasson 
     * @date 12 Dec 2016
     * @status added
     */
    @Service NetworkLabelsService networkLabels();
}