Interface VpnIds

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<VpnIds>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<PrefixToInterface>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<VpnIdsKey>

    @Generated("mdsal-binding-generator")
    public interface VpnIds
    extends org.opendaylight.yangtools.yang.binding.ChildOf<PrefixToInterface>, org.opendaylight.yangtools.yang.binding.Augmentable<VpnIds>, org.opendaylight.yangtools.yang.binding.Identifiable<VpnIdsKey>

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

     list vpn-ids {
       key vpn-id;
       leaf vpn-id {
         type uint32;
       }
       list prefixes {
         key ip_address;
         leaf ip_address {
           type string;
         }
         leaf dpnId {
           type uint64;
         }
         leaf vpn-interface-name {
           type string;
         }
         uses nvpn:network-attributes;
         leaf prefix-cue {
           type enumeration {
             enum none {
               value 0;
             }
             enum nat {
               value 1;
             }
             enum phys-net-func {
               value 2;
             }
             enum subnet-route {
               value 3;
             }
           }
           default none;
         }
       }
     }
     
    The schema path to identify an instance is odl-l3vpn/prefix-to-interface/vpn-ids

    To create instances of this class use VpnIdsBuilder.

    See Also:
    VpnIdsBuilder, VpnIdsKey
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<VpnIds> 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 VpnIds 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 VpnIds 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 VpnIds 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
      • getVpnId

        org.opendaylight.yangtools.yang.common.Uint32 getVpnId()
        Return vpnId, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 vpnId, or null if it is not present.
      • getPrefixes

        @Nullable java.util.Map<PrefixesKey,​Prefixes> getPrefixes()
        Return prefixes, or null if it is not present.
        Returns:
        java.util.Map prefixes, or null if it is not present.
      • nonnullPrefixes

        default @NonNull java.util.Map<PrefixesKey,​Prefixes> nonnullPrefixes()
        Return prefixes, or an empty list if it is not present.
        Returns:
        java.util.Map prefixes, or an empty list if it is not present.
      • key

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