Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.interfaces

Interface VpnInterface

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<VpnInterface>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<VpnInterfaces>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<VpnInterfaceKey>, NetworkAttributes
    @Generated("mdsal-binding-generator")
public interface VpnInterface
extends org.opendaylight.yangtools.yang.binding.ChildOf<VpnInterfaces>, org.opendaylight.yangtools.yang.binding.Augmentable<VpnInterface>, NetworkAttributes, org.opendaylight.yangtools.yang.binding.Identifiable<VpnInterfaceKey>

    This class represents the following YANG schema fragment defined in module l3vpn-instances-interfaces 

     list vpn-interface {
   key name;
   leaf name {
     type leafref {
       path /if:interfaces/if:interface/if:name;
     }
   }
   list vpn-instance-names {
     key vpn-name;
     leaf vpn-name {
       type string {
         length 1..40;
       }
     }
     leaf associated-subnet-type {
       type enumeration {
         enum V4Subnet {
           value 0;
         }
         enum V6Subnet {
           value 1;
         }
         enum V6InternetVPN {
           value 2;
         }
         enum V4AndV6Subnets {
           value 3;
         }
       }
     }
   }
   leaf dpn-id {
     type uint64;
   }
   leaf router-interface {
     type boolean;
   }
   uses nvpn:network-attributes;
 }
    The schema path to identify an instance is l3vpn-instances-interfaces/vpn-interfaces/vpn-interface

    To create instances of this class use VpnInterfaceBuilder.

    See Also:
    VpnInterfaceBuilder, VpnInterfaceKey

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

    • Method Detail

      • implementedInterface

        default java.lang.Class<VpnInterface> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
        Specified by:
        implementedInterface in interface NetworkAttributes

      • bindingHashCode

        static int bindingHashCode​(@NonNull VpnInterface obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull VpnInterface thisObj,
                             java.lang.Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        java.lang.NullPointerException - if thisObj is null

      • bindingToString

        static java.lang.String bindingToString​(@NonNull VpnInterface obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null

      • getName

        java.lang.String getName()
        Return name, or null if it is not present.
        Returns:
        java.lang.String name, or null if it is not present.

      • getVpnInstanceNames

        @Nullable java.util.Map<VpnInstanceNamesKey,​VpnInstanceNames> getVpnInstanceNames()
        Return vpnInstanceNames, or null if it is not present.
        Returns:
        java.util.Map vpnInstanceNames, or null if it is not present.

      • nonnullVpnInstanceNames

        default @NonNull java.util.Map<VpnInstanceNamesKey,​VpnInstanceNames> nonnullVpnInstanceNames()
        Return vpnInstanceNames, or an empty list if it is not present.
        Returns:
        java.util.Map vpnInstanceNames, or an empty list if it is not present.

      • getDpnId

        org.opendaylight.yangtools.yang.common.Uint64 getDpnId()
        Return dpnId, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint64 dpnId, or null if it is not present.

      • getRouterInterface

        java.lang.Boolean getRouterInterface()
        Return routerInterface, or null if it is not present.
        Returns:
        java.lang.Boolean routerInterface, or null if it is not present.

      • isRouterInterface

        @Deprecated(forRemoval=true)
default java.lang.Boolean isRouterInterface()
        Deprecated, for removal: This API element is subject to removal in a future version.