Interface Vpn

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Vpn>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<VpnToExtraroutes>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<VpnKey>

    @Generated("mdsal-binding-generator")
    public interface Vpn
    extends org.opendaylight.yangtools.yang.binding.ChildOf<VpnToExtraroutes>, org.opendaylight.yangtools.yang.binding.Augmentable<Vpn>, org.opendaylight.yangtools.yang.binding.Identifiable<VpnKey>

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

     list vpn {
       key vpn-name;
       leaf vpn-name {
         type string;
       }
       list extra-routes {
         key vrf-id;
         leaf vrf-id {
           type string;
         }
         list routes {
           key prefix;
           leaf prefix {
             type string;
           }
           leaf-list nexthop-ip-list {
             type string;
           }
         }
       }
     }
     
    The schema path to identify an instance is odl-l3vpn/vpn-to-extraroutes/vpn

    To create instances of this class use VpnBuilder.

    See Also:
    VpnBuilder, VpnKey
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        static int bindingHashCode​(@NonNull Vpn 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 Vpn 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 Vpn 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
      • getVpnName

        java.lang.String getVpnName()
        Return vpnName, or null if it is not present.
             
                 VPN Instance name
             
         
        Returns:
        java.lang.String vpnName, or null if it is not present.
      • getExtraRoutes

        @Nullable java.util.Map<ExtraRoutesKey,​ExtraRoutes> getExtraRoutes()
        Return extraRoutes, or null if it is not present.
        Returns:
        java.util.Map extraRoutes, or null if it is not present.
      • nonnullExtraRoutes

        default @NonNull java.util.Map<ExtraRoutesKey,​ExtraRoutes> nonnullExtraRoutes()
        Return extraRoutes, or an empty list if it is not present.
        Returns:
        java.util.Map extraRoutes, or an empty list if it is not present.
      • key

        VpnKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<VpnKey>