/*
 * Copyright 2018-present Open Networking Foundation
 *
 * 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.onosproject.openstacknetworking.api;

/**
 * Representation of augmented openstack network.
 */
public interface OpenstackNetwork {

    /**
     * Lists of network type.
     */
    enum Type {

        /**
         * LOCAL typed network.
         */
        LOCAL,

        /**
         * FLAT typed network.
         */
        FLAT,

        /**
         * VLAN typed virtual network.
         */
        VLAN,

        /**
         * VXLAN typed virtual network.
         */
        VXLAN,

        /**
         * GRE typed virtual network.
         */
        GRE,

        /**
         * GENEVE typed virtual network.
         */
        GENEVE
    }

    /**
     * Returns the openstack network ID of the augmented network.
     *
     * @return openstack network ID
     */
    String networkId();

    /**
     * Returns openstack network type.
     *
     * @return oepnstack network type
     */
    Type type();
}